md_to_gost/docs/README.md

Документация md2gost

Конвертер Markdown → DOCX для учебных работ (ТЗ МИРЭА / ГОСТ 7.32, ПИС, АПИД).

Содержание

1. Быстрый старт — установка, первое окно, exe
2. Синтаксис Markdown — чем диалект отличается от обычного MD
3. Схемы и диаграммы — UML, Mermaid, IDEF0, DFD (вшитый Graphviz / Kroki), настраиваемые схемы
4. ArchiMate 3.2 — генерация схем (макросы PlantUML, связи, viewpoints)
5. Типы документов — coursework, practice, vkr, PIS_custom, APID_coursework
6. CLI и GUI — флаги и соответствие в интерфейсе
7. Автотитульник — info_conv.yaml, блок title, ФИО/группа
8. Кастомные стили (JSON) — оверлей полей и стилей абзацев
9. Промпты для ИИ — генерация .md, расширение промпта схемами
10. Импорт Word → Markdown — DOCX в диалект md2gost (word2md)

Исходный код конвертера: md2gost/. Примеры: examples/.

Полная карта репозитория (архитектура, все функции CLI/GUI и модули кода): PROJECT.md.

В GUI: Справка → Документация — тот же набор страниц (вшит в exe).