mirror of
https://github.com/StepanovPlaton/SSAUGenerator.git
synced 2026-10-31 10:18:29 +04:00
StepanovPlaton
bf7816ab7c
- Move projects into content/<project>/{docx,pptx} with shared assets/
- Flatten config paths; output = project name in project folder
- Add pptx --init scaffold; remove docx exe build
- Add feature-complete content/example; ignore content/* except example
- Rewrite README and AGENTS.md
30 lines
1.3 KiB
Markdown
30 lines
1.3 KiB
Markdown
# SSAU Generator DOCX
|
||
|
||
Генератор отчётов **DOCX** из **Markdown** по дизайну
|
||
[СТО 02068410-004-2018](documentation/STO_SGAU_02068410-004-2018.md).
|
||
Содержимое задаётся Markdown-файлами и `config.yaml` проекта; путь выходного
|
||
файла — ключ `document.output`.
|
||
|
||
Полная инструкция по работе с документом: **[AGENTS.md](AGENTS.md)** — CLI, схема
|
||
конфига, формат контента, директивы и PlantUML.
|
||
|
||
## Быстрый старт
|
||
|
||
```powershell
|
||
node docx/src/cli.js --content content/example/docx --check # проверка
|
||
node docx/src/cli.js --content content/example/docx # собрать report.docx
|
||
```
|
||
|
||
## Разработка
|
||
|
||
```powershell
|
||
npm install
|
||
npm run generate # локальная сборка (node src/cli.js)
|
||
npm run check # проверка конфига и ссылок
|
||
npm run init # создать шаблон проекта
|
||
```
|
||
|
||
Структура кода: `src/cli.js` (точка входа), `src/config/` (дефолты, загрузка и
|
||
валидация `config.yaml`, шаблон), `src/markdown/` (markdown-it и директивы),
|
||
`src/render/` (сборка DOCX), `src/plantuml/` (рендеринг схем).
|