Базовая разметка

Строчное форматирование

Для форматирования фрагментов текста в строке используйте приведенные ниже способы разметки.

Для использования нижнего регистра или подчеркнутого текста необходимо подключить дополнительные плагины. Подробнее в разделе Дополнительные возможности.

Параграфы

Для создания параграфа отделите пустой строкой один блок текста от другого.

Параграф.

Следующий параграф.

Результат:

Параграф.

Следующий параграф.

Переносы строк

Для переноса строки перенесите каретку.

Строка.
Следующая строка.

Результат:

Строка.
Следующая строка.

Чтобы вместо переноса каретки использовать два пробела в конце строки, в настройках задайте значение breaks: false.

Заголовки

Выделяют следующие уровни заголовков:

• первый уровень (h1) для заголовка страницы;
• второй (h2), третий (h3), четвертый (h4) и т.д уровни для заголовков подразделов.

# Заголовок h1
## Заголовок h2
### Заголовок h3
#### Заголовок h4

Во время сборки для каждого заголовка формируется якорь. Якоря позволяют создавать ссылки, ведущие на разделы документа.

По умолчанию якорь в YFM — это текст заголовка, записанный в латинской транслитерации. Вы можете задать якорь вручную, указав его после заголовка:

## Заголовок h2 {#anchor}

Чтобы одновременно с якорями в стиле YFM также генерировались якоря по правилам GitHub, в настройках задайте значение supportGithubAnchors: true.

Цитаты

Для отображения цитаты используйте следующую разметку:

> Цитирование

Результат:

Цитирование

> Цитирование
>> Вложенное цитирование

Результат:

Цитирование

Вложенное цитирование

Экранирование

Чтобы служебный символ разметки не был интерпретирован, экранируйте его с помощью символа \.

Верхний^регистр^
Верхний\^регистр^

Результат:

Верхний^{регистр}
Верхний^регистр^

Использование HTML

По умолчанию YFM экранирует HTML. Чтобы отключить экранирование, в настройках задайте значение allowHTML: true.