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

Форматирование текста

Абзацы, выделение, строчный код, экранирование и типографика

На этой странице

Абзацы и переводы строк

Абзацы — блоки текста, разделённые пустой строкой. Одиночный перевод строки внутри абзаца строку не разрывает — текст перетекает. Чтобы принудительно разорвать строку внутри абзаца, завершите её обратной косой чертой или двумя пробелами:

Результат

Первая строка.
Вторая строка того же абзаца.

Markdown
Первая строка.\
Вторая строка того же абзаца.

Выделение

Вы пишетеПолучается
**полужирный**полужирный
*курсив*курсив
***полужирный курсив***полужирный курсив
~~зачёркнутый~~зачёркнутый
==выделенный==выделенный
`строчный код`строчный код

Замечания:

  • Зачёркиванию нужны две тильды с каждой стороны. Одна тильда – нижний индекс.
  • ==выделение== рендерится подсвеченным фрагментом (HTML-элемент <mark>). Работает на простом тексте; через другое форматирование не переносится.
  • Подчёркивания работают как альтернатива звёздочкам (_курсив_, __полужирный__), но звёздочки — домашний стиль, и они работают внутри слова.

Нижние и верхние индексы

Результат

H2O, x2, CO2, м3

Markdown
H~2~O, x^2^, CO~2~, м^3^

Для чего-то сложнее короткого индекса — выражений, греческих букв, вложенных степеней — используйте математику: $x_{n+1}^2$.

Списки определений

Результат
Следствие
Утверждение, вытекающее из теоремы без дополнительного доказательства или почти без него.
Markdown
Следствие
: Утверждение, вытекающее из теоремы без дополнительного доказательства
или почти без него.

Термин на отдельной строке, каждое определение — на следующей строке, начинающейся с двоеточия. Тело определения держите в простом тексте с базовым выделением — для статей, которым нужна математика, используйте утверждение-определение.

Типографика

Двойной и тройной дефис становятся типографскими тире:

Вы пишетеПолучаетсяДля чего
с. 3--7с. 3–7диапазоны (короткое тире)
мысль --- вот такаямысль — вот такаятире в тексте

Кавычки и многоточия остаются как набраны — автозамены кавычек нет.

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

Обратная косая черта перед символом даёт его буквально там, где иначе он был бы синтаксисом:

Результат

*не курсив*, цена в $5

Markdown
\*не курсив\*, цена в \$5

Это покрывает синтаксис CommonMark и математику: \$ не даёт знаку доллара открыть формулу. Два случая на обратную косую черту не реагируют:

  • Парные ==...== на простом тексте всегда становятся выделением. Одиночное == остаётся буквальным; чтобы показать парную форму, поместите её в `строчный код`.
  • Строка, начинающаяся с :::, открывает директиву; буквальный синтаксис директив показывайте в блоке кода.

Внутри строчного кода и блоков кода ничто не интерпретируется, так что экранирование там не нужно никогда.