Igor20264
37 lines
1.7 KiB
Markdown
37 lines
1.7 KiB
Markdown
# GhostEditor / md2gost
|
|
|
|
Конвертер **Markdown → DOCX** по методическим указаниям РТУ МИРЭА (ГОСТ 7.32-2017) и профилям ПИС / АПИД. Есть GUI, CLI и промпты для генерации `.md` через ИИ.
|
|
|
|
## Быстрый старт
|
|
|
|
```bash
|
|
pip install -e .
|
|
python -m md2gost # GUI
|
|
python -m md2gost report.md -o report.docx --type coursework --check
|
|
```
|
|
|
|
Windows: `build-exe.bat` → `dist\md2gost.exe` (двойной клик — GUI).
|
|
|
|
## Документация
|
|
|
|
Полная карта проекта (что уже умеет, пайплайны, модули): [`PROJECT.md`](PROJECT.md).
|
|
|
|
Пользовательская документация — в [`docs/`](docs/):
|
|
|
|
| Раздел | Содержание |
|
|
|--------|------------|
|
|
| [Быстрый старт](docs/quickstart.md) | Установка, GUI, типы документов |
|
|
| [Синтаксис Markdown](docs/markdown.md) | Диалект md2gost vs обычный MD |
|
|
| [Схемы и диаграммы](docs/schemes.md) | PlantUML, Mermaid, `md2gost.schemes.json` |
|
|
| [Типы работ](docs/types.md) | coursework, practice, vkr, PIS, APID |
|
|
| [CLI и GUI](docs/cli-gui.md) | Флаги и где они в окне |
|
|
| [Промпты для ИИ](docs/prompts.md) | Генерация MD, кнопки схем в GUI |
|
|
|
|
Краткая справка по пакету: [`md2gost/README.md`](md2gost/README.md).
|
|
Промпты: [`prompts/`](prompts/).
|
|
|
|
## Связанные форматы
|
|
|
|
- FODT (LibreOffice): `python -m md2fodt` — [`md2fodt/`](md2fodt/)
|
|
- PDF через LaTeX: [`md2latex/`](md2latex/)
|