База знаний
Войти

Элементы оформления текста

1. Заголовки и структура

УровеньСинтаксис (MD)Стиль оформления (PDF)
Заголовок 1Подкаталог первого уровня (например, /ustanovka/002.obshie-sved) соответствует названию заголовка 1 уровня "Общие сведения" в документе "Установка"Roboto, 16 пт, полужирный, ВСЕ ПРОПИСНЫЕ.
Центрирование, интервалы: 30 пт до / 18 пт после.
Заголовок 2# Текст заголовка (внутри md-файла, который размещается в подкаталоге 1 уровня. Например, /ustanovka/002.obshie-sved/001.opisanie.md)Roboto, 14 пт.
Отступ первой строки: 1,25 см. Интервалы: 24 пт до / 12 пт после.
Заголовок 3## Текст заголовкаRoboto, 14 пт, полужирный.
Отступ первой строки: 1,25 см. Интервалы: 18 пт до / 12 пт после.
Заголовок 4### Текст заголовкаRoboto, 14 пт, полужирный.
Отступ первой строки: 1,25 см. Интервалы: 18 пт до / 12 пт после.
Заголовок 5 и ниже#### Текст заголовкаRoboto 12 пт, полужирный.
Отступ первой строки: 1,25 см. Интервалы: 12 пт до / 6 пт после.

2. Акценты и предупреждения

Примечание

  • Синтаксис MD:
    > Примечание – Текст примечания...
  • Отображение в PDF: Слово "Примечание" выделяется разреженным шрифтом (интервал 2 пт). Остальной текст — обычный Roboto 11 пт.

❗️ Акценты "Важно" и "Следует обратить внимание"

  • Синтаксис MD: Вводные слова Важно и Следует обратить внимание выделяются через **текст**, далее текст в потоке.

    Важно, чтобы семейство процессора совпадало...

  • Отображение в PDF: Полужирным выделяется только только вводные слова. Остальной текст Roboto 12 пт.

3. Медиа-объекты

Изображение и подпись

  • Синтаксис MD:
    ::sign-image
---
src: /путь/к/файлу.png
sign: Рисунок 1 — Описание рисунка
height: 90% (настройки масштаба, если не помещается рамку)
---
::
  • Отображение рисунка в PDF: По центру, интервал перед 18 пт.
  • Отображение подписи к рисунку в PDF: Roboto 12пт, интервал после 18 пт,выравнивание по центру, нумерация (Рисунок X).

Таблица и подпись

  • Синтаксис MD:
    ::app-collapsible
---
label: "Таблица 1 - Название таблицы"
---
#content
<table>...</table>
::
  • Отображение заголовка таблицы в PDF: Roboto 10 пт, полужирный, по центру.
  • Отображение ячеек в PDF: Roboto 10 пт, отступ первой строки 0 см.
  • Отображение подписи к таблице в PDF: Roboto 12 пт, выравнивание по ширине, интервал перед 12 пт, нумерация (Таблица X).

Текст после таблицы

  • Отображение в PDF: Roboto 12 пт. Отступ первой строки 1,25 см. Интервалы: 12 пт до / 6 пт после.

4. Списки

Нумерованный список

  • Синтаксис MD:
    1. Пункт списка;
2. Второй пункт.
  • Отображение в PDF: Roboto 12 пт, отступ первой строки 1,25 см. Маркеры: 1. 2. 3. или а. б. в. (в зависимости от уровня вложенности в стиле).

Вложенные списки (2-й уровень)

  • Синтаксис MD:
    1. Основной пункт:
   - Вложенный пункт (тире для PDF/минус для md).
  • Отображение в PDF: Roboto 12 пт. Отступ слева 1,85 см. Маркеры: тире (—).

5. Код и UI элементы

Область кода

  • Синтаксис MD:
    ```bash Terminal
команда_в_терминале
```
  • Отображение в PDF: Шрифт Roboto Mono 12 пт. Заливка: Белый, фон 1, более темный оттенок 15%. Отступ первой строки 1,25 см. Выравнивание по левому краю.

Кнопка / Клавиша

  • Синтаксис MD: Текст в потоке (выделение полужирным через **).

    ...нажать кнопку Начать установку...

  • Отображение в PDF: Шрифт Roboto Mono, 12 пт. Не полужирный, не курсив. Без границ.

Выделение фрагментов (переменные, пути)

  • Синтаксис MD: Текст в потоке (выделение через текст).

    ...файл /etc/puppetlabs/puppet/puppet.conf...

  • Отображение в PDF: Roboto Serif 12 пт, в потоке абзаца. Отступ первой строки 1,25 см.