Yandex Flavored Markdown

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

Преимущества:

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

Синтаксис

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

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

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

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

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

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

В разработке

В следующих релизах YFM планируется добавление функций:

  • cтатический линтер;
  • индекс удовлетворенности пользователей на страницах документации;
  • автоматическая локальная пересборка при внесении изменений;
  • отображение контрибьюторов на страницах.
Предыдущая