Базовая разметка
Строчное форматирование
Чтобы выделить фрагмент текста, поставьте разметку с двух сторон от него:
**Полужирный текст**
*Курсив*
~~Зачеркнутый текст~~
Результат:
Полужирный текст
Курсив
Зачеркнутый текст
Заголовки
Заголовок отмечается знаками «#» в начале строки: чем больше знаков, тем глубже уровень заголовка.
# Кухня
Комната с балконом и окном
## Стол
За ним едят
## Стул
На нем сидят
# Кладовка
Здесь пусто
Результат:
1 Кухня
Комната с балконом и окном
1.1 Стол
За ним едят
1.2 Стул
На нем сидят
2 Кладовка
Здесь пусто
Комментарии
Комментарий в шаблоне записывается так:
{# Комментарий #}
Примечание
Содержимое конструкции отображается только в md-коде: в предпросмотр и выгружаемый документ комментарий не попадает.
Пустые строки
Разметка переносится в Word построчно, поэтому каждая пустая строка становится пустым абзацем в DOCX и PDF. Абзацы и так разделяются переводом строки, отбивать их пустой строкой не нужно. Таблицы, блоки кода и картинки тоже распознаются без пустых строк вокруг.
Пустая строка нужна в двух случаях:
- после картинки с подписью — она отделяет подпись «Рисунок N — ...» от следующего абзаца;
- на титульном листе — там пустые строки работают как вертикальные отступы.
Код
Блок кода выделяется строками из трех обратных апострофов (```) до и после кода. В DOCX и PDF он выгружается моноширинным шрифтом. Так выглядит блок с одной строкой кода:
GET /api/projects
Язык у блока кода не указывайте
Если сразу после открывающих апострофов написать язык (например, jinja или bash), эта метка попадет в DOCX и PDF видимой строкой вида «[jinja]».
Короткий фрагмент кода внутри строки выделяется одиночными обратными апострофами: GET /api/projects. В DOCX он выгружается моноширинным шрифтом с подложкой. Разметка внутри апострофов не разбирается: **kwargs останется текстом.