Yandex Flavored Markdown

Yandex Flavored Markdown (YFM) — диалект Markdown с дополнительным набором инструментов для трансформации Markdown в HTML и сборки документационных проектов.

Особенности:

• Совместимость со стандартом CommonMark Spec.
• Включает набор плагинов с дополнительными элементами разметки.
• Возможность подключения сторонних плагинов markdown-it и создания собственных.
• Безопасность: HTML экранируется по умолчанию.
• Динамическая валидация.
• Сборка документационного проекта.

Синтаксис

Синтаксис Yandex Flavored Markdown основан на CommonMark Spec и дополнен элементами из других языков разметки и шаблонизаторов:

• заметки;
• каты, табы и радиобаттоны;
• всплывающие окна;
• видео;
• переменные;
• переиспользование контента.

Подробнее в разделе Синтаксис.

Создание документационных проектов

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

Собранный проект представляет собой набор статических HTML, которые можно просмотреть локально или разместить на хостинге, в GitHub Pages или S3. Он может включать:

• Оглавление документа.

• Разводящие страницы для навигации.

• Пресеты переменных для поддержки разных версий документации из одних и тех же исходных файлов.

• Переиспользование контента.

• Пользовательские настройки отображения:

  • широкий формат;
  • навигация по текущей статье;
  • темная тема;
  • размер текста.

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

Кроме стандартной сборки всех файлов в HTML доступна сборка в YFM.