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

Руководство по Markdown

Всё, что публикуется на LibreTimes – лекции, статьи, задачники, диссертации – пишется на LibreTimes Markdown. В основе это стандартный Markdown, расширенный для академического письма: математика, теоремные блоки, диаграммы и медиа.

Формат устроен в три слоя, и руководство следует им по порядку:

  1. CommonMark – стандартное ядро. Заголовки, выделение, списки, ссылки, цитаты, код. Если вы писали Markdown где угодно, этот слой вы уже знаете.
  2. GFM (GitHub Flavored Markdown) – распространённые расширения: таблицы, сноски, списки задач, зачёркивание, автоссылки. Разобраны вместе с основами.
  3. Расширения LibreTimes – то, что делает формат академическим: математика на KaTeX, подсветка кода и блочные директивы – теоремы и доказательства, выноски, сворачиваемые секции, вкладки, диаграммы TikZ, видео, упоминания и вложения.

Всё, что корректно на нижнем слое, остаётся корректным выше: обычный документ CommonMark – уже корректный документ LibreTimes.

Короткий пример

## Теорема Пифагора
 
:::theorem[Пифагор]
Для прямоугольного треугольника с катетами $a$, $b$ и гипотенузой $c$:
 
$$
a^2 + b^2 = c^2
$$
:::
 
:::proof
Опустим высоту из прямого угла и сравним подобные треугольники.
:::

рендерится как:

Теорема Пифагора

Теорема (Пифагор). Для прямоугольного треугольника с катетами , и гипотенузой :

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

Разделы

РазделЧто описывает
ОсновыCommonMark + GFM: текст, заголовки, списки, ссылки, изображения, цитаты, таблицы, сноски
МатематикаKaTeX: строчные и выключные формулы, разделители, основные команды
Блоки кодаПодсветка синтаксиса, заголовки блоков, строчный код
РасширенияСинтаксис директив и все блоки LibreTimes: утверждения, выноски, иллюстрации, спойлеры, вкладки, TikZ, видео, упоминания, вложения
КомментарииСокращённый формат для комментариев
HTML и безопасностьКакой HTML разрешён и как контент санитизируется
ШпаргалкаВсё на одной странице

Где что действует

Публикации используют полный формат. Комментарии – сокращённый набор: тот же текстовый синтаксис, но без медиа и блочных расширений. Редактор пишет этот синтаксис за вас; руководство – справочник того, что этот синтаксис значит, набираете ли вы его в режиме исходника или импортируете написанное в другом месте.

Одно правило, которое стоит знать сразу

Заголовок страницы не входит в тело документа. Название, введённое при публикации, рендерится единственным заголовком верхнего уровня, поэтому заголовки в теле начинаются со второго уровня. Если в документе всё же есть заголовок верхнего уровня (# Название), всё дерево заголовков сдвигается на один ранг вниз с сохранением иерархии – см. Заголовки.