Справочник синтаксиса

На этой странице собран весь словарь LibreTimes Markdown: каждая пометка, ограничитель, директива и атрибут, и что из них получается. Каждая таблица строится из собственного определения диалекта при каждой публикации сайта, поэтому она не может отстать от того, что принимает рендерер. Как пользоваться конструкцией, рассказано на её странице — переходите по ссылке.

Всё перечисленное — дополнение к стандартному Markdown (CommonMark и GitHub Flavored Markdown): заголовки, списки, ссылки, изображения, цитаты, таблицы, сноски и блоки кода работают так же, как везде. См. Основы.

Разметка в строке

Пометки, которые меняют фрагмент текста внутри абзаца. В столбце Результат стоит сам образец, отрендеренный.

Пишется	Результат	Примечание
`bold`	bold	Сильное выделение.
`italic`	italic	Выделение.
`code`	`code`	Код в строке; внутри ничего не интерпретируется.
`~~struck~~`	~~struck~~	Две тильды с каждой стороны; одна тильда — нижний индекс.
`==highlighted==`	highlighted	Выделенный цветом фрагмент обычного текста.
`H~2~O`	H₂O	Короткий индекс под строкой.
`x^2^`	x²	Короткий индекс над строкой.
`pages 3--7`	pages 3–7	Два дефиса: короткое тире, для диапазонов.
`a pause---then`	a pause—then	Три дефиса: длинное тире.

Кавычки и многоточия остаются такими, какими набраны. Подробности и крайние случаи — на странице Форматирование текста.

Математика

Принимаются четыре способа записи. Будет ли формула в строке или выключной, решает то, стоят ли ограничители на отдельных строках, а не то, какие ограничители выбраны.

Пишется	Результат	Примечание
$x^2$	$x^{2}$ , в строке	Формула в строке.
`$x^2$`	$x^{2}$ , в строке	Формула в строке, как в LaTeX.
`$$x^2$$`	$x^{2}$ , в строке	Всё ещё в строке: на одной строке двойные доллары не дают выключной формулы.
`\[x^2\]`	$x^{2}$ , в строке	На одной строке тоже в строке: сначала переписывается в двойные доллары.
`$$` `x^2` `$$`	выключная формула, по центру на своей строке	Выключная формула: ограничители на отдельных строках.
`\[` `x^2` `\]`	выключная формула, по центру на своей строке	Выключная формула, как в LaTeX, тоже на отдельных строках.

Подробнее — Математика.

Директивы

Директива — именованный блок :::имя … ::: или именованный фрагмент внутри предложения :имя[…]. Здесь перечислены все имена, которые знает диалект; любое другое имя показывается так, как набрано. Сам синтаксис объяснён на странице Расширения.

Конструкция	Директивы	Форма	Свои ключи	Что это
Утверждения	`:::theorem` `:::lemma` `:::corollary` `:::conjecture` `:::definition` `:::proof` `:::example` `:::remark` `:::problem` `:::solution` `:::hint` `:::statement`	блок	`number` `label`	Блоки в стиле теорем с меткой в начале строки.
Выноски	`:::callout` `:::note` `:::tip` `:::important` `:::warning` `:::caution`	блок	`label`	Выноски в рамке со строкой заголовка.
Иллюстрации	`:::figure`	блок	—	Одно изображение, диаграмма или галерея с подписью.
Галереи	`:::gallery`	блок	—	Несколько изображений, показанных одной группой.
Сворачиваемые секции	`:::spoiler`	блок	—	Блок, закрытый, пока читатель его не откроет.
Вкладки	`:::tabs` `:::tab`	блок	`group` `name`	Варианты рядом, показывается один.
Диаграммы TikZ	`:::tikz`	блок	`bg`	Диаграмма на TikZ, компилируется при сохранении.
Книжные блоки	`:::verse` `:::epigraph` `:::dedication` `:::letter` `:sc[…]` `:pb[…]`	блок, внутри предложения	—	Стихи, эпиграфы, письма, капитель и номера печатных страниц.
Вложения	`:attach[…]`	внутри предложения	`id`	Ссылка на файл, приложенный к работе.

Утверждения

Семейство теорем. Каждый вид выводится с полужирной меткой в начале первой строки, а тело идёт сразу за ней, в той же строке.

Вид	Метка	Тело	В конце	Показ	Для чего
`theorem`	Теорема.	курсив		открыт	Основной результат текста.
`lemma`	Лемма.	курсив		открыт	Вспомогательный результат, нужный для другого доказательства.
`corollary`	Следствие.	курсив		открыт	Результат, который вытекает из только что доказанного.
`conjecture`	Гипотеза.	курсив		открыт	Утверждение, которое считают верным, но не доказали.
`definition`	Определение.	прямой		открыт	Вводит термин или объект.
`proof`	Доказательство.	прямой	∎	открыт	Обоснование утверждения, стоящего над ним.
`example`	Пример.	прямой		открыт	Разобранный случай, который иллюстрирует теорию.
`remark`	Замечание.	прямой		открыт	Комментарий к теории, который сам не является результатом.
`problem`	Задача.	прямой		открыт	Упражнение для читателя, единица листка задач.
`solution`	Решение.	прямой	∎	свёрнут до клика	Ответ к задаче, внутри которой стоит.
`hint`	Подсказка.	прямой		свёрнут до клика	Подсказка к решению задачи, внутри которой стоит.
`statement`	Предложение.	прямой		открыт	Любой другой вид с вашим словом в метке: `:::statement[Предложение]`.

В столбце Метка — метка на языке этой страницы. Документ получает метки на своём языке, на каком бы языке ни был интерфейс у читателя:

Вид	Английский (`en`)	Русский (`ru`)	Испанский (`es`)	Французский (`fr`)	Немецкий (`de`)	Китайский (`zh`)
`theorem`	Theorem	Теорема	Teorema	Théorème	Satz	定理
`lemma`	Lemma	Лемма	Lema	Lemme	Lemma	引理
`corollary`	Corollary	Следствие	Corolario	Corollaire	Korollar	推论
`conjecture`	Conjecture	Гипотеза	Conjetura	Conjecture	Vermutung	猜想
`definition`	Definition	Определение	Definición	Définition	Definition	定义
`proof`	Proof	Доказательство	Demostración	Démonstration	Beweis	证明
`example`	Example	Пример	Ejemplo	Exemple	Beispiel	例
`remark`	Remark	Замечание	Observación	Remarque	Bemerkung	注
`problem`	Problem	Задача	Problema	Problème	Aufgabe	问题
`solution`	Solution	Решение	Solución	Solution	Lösung	解答
`hint`	Hint	Подсказка	Pista	Indication	Hinweis	提示

Документ на любом другом языке получает английские метки. Метка :::statement[…] и заданная вами label="…" выводятся ровно так, как написаны, и не переводятся. Подробнее — Утверждения.

Выноски

Выноски в рамке. В строке заголовка — название вида на языке документа, если вы не задали своё через label="…".

Вид	Заголовок	Когда использовать
`callout`	Выноска	Ни один другой вид не подходит: нейтральная рамка.
`note`	Заметка	Читатель может пропустить это, не потеряв нить.
`tip`	Совет	Есть способ проще или лучше.
`important`	Важно	Без этого у читателя не получится.
`warning`	Предупреждение	Здесь часто ошибаются.
`caution`	Осторожно	У действия есть последствия, которые трудно отменить.

Вид	Английский (`en`)	Русский (`ru`)	Испанский (`es`)	Французский (`fr`)	Немецкий (`de`)	Китайский (`zh`)
`callout`	Callout	Выноска	Recuadro	Encadré	Kasten	提示框
`note`	Note	Заметка	Nota	Note	Hinweis	注释
`tip`	Tip	Совет	Consejo	Astuce	Tipp	提示
`important`	Important	Важно	Importante	Important	Wichtig	重要
`warning`	Warning	Предупреждение	Advertencia	Avertissement	Warnung	警告
`caution`	Caution	Осторожно	Precaución	Attention	Vorsicht	注意

Подробнее — Выноски.

Книжные блоки

Для стихов, эпиграфов, писем и особенностей печатного издания. Работают в любом документе, не только в книгах.

Конструкция	Форма	Что это
`:::verse`	блок	Стихи: каждая строка остаётся строкой, пустая строка разделяет строфы.
`:::epigraph`	блок	Цитата, которая предваряет последующий текст.
`:::dedication`	блок	Посвящение.
`:::letter`	блок	Письмо или документ, приведённый внутри текста.
`:sc[…]`	внутри предложения	Капитель внутри предложения.
`:pb[…]`	внутри предложения	Место, где начиналась печатная страница; арабский или римский номер.

Подробнее — Стихи, эпиграфы и письма.

Атрибуты блоков

Свойства блока. Их пишут либо отдельной строкой прямо над блоком ({align=center}), либо в открывающей ограде директивы (:::theorem{#main number=3.17}). Первые три ключа работают на любом блоке, остальные принадлежат директиве из столбца Где.

Ключ	Значения	Где	Значит
`#id`	`[A-Za-z][A-Za-z0-9_.:-]{0,99}`	любой блок: в строке атрибутов или в ограде директивы	Постоянный якорь блока, чтобы на него вела ссылка `[см.](#имя)`.
`align`	`left` по левому краю, `center` по центру, `right` по правому краю, `justify` по ширине	любой блок: в строке атрибутов или в ограде директивы	Как строки располагаются по ширине.
`indent`	`none` без абзацного отступа, `first` с абзацным отступом, `hanging` с выступом первой строки	любой блок: в строке атрибутов или в ограде директивы	Форма левого края.
`number`	текст, не длиннее 32 символов, одна строка	ограда: Утверждения	Номер, напечатанный в источнике, вместо автоматического.
`label`	текст, не длиннее 32 символов, одна строка	ограда: Утверждения	Слово из источника вместо метки вида. `label=""` убирает слово.
`label`	текст, не длиннее 32 символов, одна строка	ограда: Выноски	Заголовок рамки вместо переведённого. `label=""` убирает строку заголовка.
`group`	`[A-Za-z0-9_-]{1,40}`	ограда: `:::tabs`	Группы вкладок с одинаковым именем переключаются вместе.
`name`	текст	ограда: `:::tab`	Название вкладки.
`bg`	задаёт редактор	ограда: `:::tikz`	Фон, на котором редактор показывает диаграмму. Опубликованная страница его не использует.
`id`	идентификатор вложения	ограда: `:attach[…]`	Вложение, которое открывает ссылка.

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

Ограничения

Границы, которые соблюдает разборщик. Они нужны, чтобы никакая строка текста не могла замедлить рендеринг или сделать страницу нечитаемой.

Ограничение	Значение	Если превышено
Длина списка атрибутов	512 символов	строка остаётся текстом
Записей в списке атрибутов	16	строка остаётся текстом
Длина печатного `number=` или `label=`	32 символов	ключ игнорируется
Пробелов на уровень отступа в стихах	2	—
Самый глубокий уровень отступа в стихах	3	более глубокие строки получают этот уровень