vkr-authoring

Writing thesis Markdown

Full specification: docs/llm-format/README.md (ru) / docs/llm-format/README.en.md (en). Output Markdown only; the sole HTML allowed is the <!-- @suppress --> directive.

Structure

• One logical section per file under the profile's markdown_dir; the build order is markdown_files in config.yaml. A new file is invisible until listed there.
• _bundle.md is generated by merge and deleted afterwards — never edit, reference or commit it.
• Headings: # 1 Название, ## 1.1 Подраздел, no period after the number. Structural sections keep their canonical Russian caps names (# ВВЕДЕНИЕ, # СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ, # ПРИЛОЖЕНИЕ А). Appendix letters skip I, O and Ё З Й О Ч Ь Ъ.

Numbered objects always use a key

![схема](pipeline.png)
Рисунок {pipeline} - Конвейер обработки

Таблица {req} - Требования
| Параметр | Значение |
|---|---|
| A | B |

• Figure caption immediately after the image, no blank line between them.
• Table and listing captions immediately before their block.
• Spaced separator - or – after the key; keys short, lowercase, unique per kind. Numbers are assigned at build time.
• A listing may be pulled from a file instead of pasted: @listing md.py on its own line under the caption, @listing md.py:582-607 for a fragment. Path is relative to listings_dir (or images_dir when unset).

References, citations, formulas

• Always by key: [рис:pipeline], [табл:req], [лист:split], [форм:count]. Never hard-code a number.

• Citations [1], [1; 2], [1-3]; [1, 2] is not a GOST citation. Keyed style ([{gruber}]) is an alternative — do not mix the two.

• Escape literal brackets in prose: \[note\], \{key\}.

• Display formula numbered by a key line directly under it:

  \[ N = \sum_{i=1}^{k} 1 \]
  {count}
  

Tables and lists

Pipe tables only; every body row must match the header's cell count (that is an error, not a warning). - , 1), а) for lists, two-space indent for nesting.