Синтаксис

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

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

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

Для оформления используется:

• базовая разметка;
• ссылки;
• списки;
• простые и многострочные таблицы;
• заметки;
• каты, табы и радиобаттоны;
• изображения и видео;
• фрагменты кода;
• всплывающие подсказки;
• переменные.

Кроме элементов, включенных в пакет, доступно подключение дополнительных возможностей через плагины markdown-it.