Форматирование текста
Абзацы и переводы строк
Абзацы – блоки текста, разделённые пустой строкой. Одиночный перевод строки внутри абзаца строку не разрывает – текст перетекает. Чтобы принудительно разорвать строку внутри абзаца, завершите её обратной косой чертой или двумя пробелами:
Первая строка.\
Вторая строка того же абзаца.Выделение
| Вы пишете | Получается |
|---|---|
**полужирный** | полужирный |
*курсив* | курсив |
***полужирный курсив*** | полужирный курсив |
~~зачёркнутый~~ | |
==выделенный== | выделенный |
`строчный код` | строчный код |
Замечания:
- Зачёркиванию нужны две тильды с каждой стороны. Одна тильда – нижний индекс.
==выделение==рендерится подсвеченным фрагментом (HTML-элемент<mark>). Работает на простом тексте; через другое форматирование не переносится.- Подчёркивания работают как альтернатива звёздочкам (
_курсив_,__полужирный__), но звёздочки – домашний стиль, и они работают внутри слова.
Нижние и верхние индексы
H~2~O, x^2^, CO~2~, м^3^рендерится как: H2O, x2, CO2, м3
Для чего-то сложнее короткого индекса – выражений, греческих букв,
вложенных степеней – используйте математику:
$x_{n+1}^2$.
Списки определений
Следствие
: Утверждение, вытекающее из теоремы без дополнительного доказательства
или почти без него.- Следствие
- Утверждение, вытекающее из теоремы без дополнительного доказательства или почти без него.
Термин на отдельной строке, каждое определение – на следующей строке, начинающейся с двоеточия. Тело определения держите в простом тексте с базовым выделением – для статей, которым нужна математика, используйте утверждение-определение.
Типографика
Двойной и тройной дефис становятся типографскими тире:
| Вы пишете | Получается | Для чего |
|---|---|---|
с. 3--7 | с. 3–7 | диапазоны (короткое тире) |
мысль --- вот такая | мысль — вот такая | тире в тексте |
Кавычки и многоточия остаются как набраны – автозамены кавычек нет.
Экранирование
Обратная косая черта перед символом даёт его буквально там, где иначе он был бы синтаксисом:
\*не курсив\*, цена в \$5Это покрывает синтаксис CommonMark и математику: \$ не даёт знаку доллара
открыть формулу. Два случая на обратную
косую черту не реагируют:
- Парные
==...==на простом тексте всегда становятся выделением. Одиночное==остаётся буквальным; чтобы показать парную форму, поместите её в`строчный код`. - Строка, начинающаяся с
:::, открывает директиву; буквальный синтаксис директив показывайте в блоке кода.
Внутри строчного кода и блоков кода ничто не интерпретируется, так что
экранирование там не нужно никогда.