mirror of
https://github.com/StepanovPlaton/SSAUGenerator.git
synced 2026-10-31 10:18:29 +04:00
43 lines
2.0 KiB
Markdown
43 lines
2.0 KiB
Markdown
# DocxGenerator
|
||
|
||
Автономный генератор отчётов **DOCX** из **Markdown** по дизайну
|
||
[СТО 02068410-004-2018](documentation/STO_SGAU_02068410-004-2018.md).
|
||
Поведение полностью задаётся файлом `config.yaml`; путь выходного файла — ключ
|
||
`document.output`.
|
||
|
||
Полная документация: **[AGENTS.md](AGENTS.md)** — CLI, схема конфига, формат контента,
|
||
директивы и сборка `.exe`.
|
||
|
||
## Быстрый старт
|
||
|
||
```powershell
|
||
.\DocxGenerator.exe --init # создать config.yaml, примеры content/ и content/assets/
|
||
# ... правим config.yaml и content/*.md ...
|
||
.\DocxGenerator.exe --check # проверить ссылки и конфиг
|
||
.\DocxGenerator.exe # собрать report.docx
|
||
```
|
||
|
||
## Разработка
|
||
|
||
```powershell
|
||
npm install
|
||
npm run generate # локальная сборка report.docx
|
||
npm run check # проверка конфига и ссылок
|
||
npm run build:exe # собрать DocxGenerator.exe в корне (@yao-pkg/pkg, node24-win-x64)
|
||
```
|
||
|
||
## Структура репозитория
|
||
|
||
| Путь | Назначение |
|
||
|------|------------|
|
||
| `src/cli.js` | точка входа, разбор аргументов |
|
||
| `src/config/` | дефолты, загрузка и валидация `config.yaml`, шаблон |
|
||
| `src/markdown/` | markdown-it, директивы `:::`, инлайн-ссылки `[@n]`, `@fig/@tbl/@eq` |
|
||
| `src/render/` | сборка DOCX: стили, примитивы, нумерация, слияние титульника |
|
||
| `src/build.js` | оркестрация сборки |
|
||
| `content/` | примеры Markdown |
|
||
| `content/assets/` | PNG для рисунков, опциональный `title-page.docx` |
|
||
| `documentation/` | стандарт СТО |
|
||
|
||
Инструмент не рендерит диаграммы: PNG готовятся заранее и кладутся в `content/assets/images/`.
|