Перейти к содержимому
Eventicious Help

Справка по YFM-разметке

Что внутри

Заметки note, сворачиваемые блоки cut, вкладки tabs, таблицы, блоки кода, изображения из public/ и определения терминов.

Кратко

YFM (Yandex Flavored Markdown) — диалект Markdown с расширенным набором блоков, который применяется в базе знаний Eventicious. Страница собрана как единый справочник по поддерживаемым конструкциям. Используйте её как шпаргалку при оформлении статей: рендер настроен на уровне сайта, дополнительных плагинов подключать не нужно.

Когда использовать

  • Заметка note — короткий информер с цветовым акцентом: предупреждение, подсказка, отступление.
  • Скрываемый блок cut — необязательные детали, длинные примеры, редкие сценарии.
  • Вкладки tabs — несколько вариантов одной инструкции: для разных ролей, продуктов или сред.
  • Таблица — сравнение параметров, списков или конфигураций.
  • Блок кода — конфиги, JSON, команды, сниппеты.
  • Изображение — схемы, скриншоты, диаграммы из директории public/.
  • Термин — определение, на которое можно сослаться в тексте через [термин](*id).

Как настроить

YFM-блоки добавляются прямо в .md-файле через директивы в формате {% имя %}. Рендер выполняется пакетом @diplodoc/transform и подключён к сайту по умолчанию — отдельных шагов сборки не требуется.

Базовая разметка

  • Обычные абзацы и списки поддерживаются как в стандартном Markdown.
  • inline code получает YFM-стили автоматически.
  • Внутренние ссылки между статьями сохраняют работоспособность.

Примеры использования

Note

Что проверяем

Рендер заметок, скрываемых блоков, вкладок, таблиц, кода, внутренних якорей, изображений из public/ и терминов.

Cut

Показать детали интеграции

Контент внутри cut раскрывается на клиенте после подключения рантайма @diplodoc/transform.

Tabs

Рендер происходит в Starlight, но HTML для .md-страниц подменяется результатом @diplodoc/transform.

Целевой формат уже совпадает с YFM/Gravity UI, поэтому LLM-rewrite и визуальный редактор смогут работать поверх одного контракта.

Таблица

Блок Ожидание
note Цветной информер
cut Раскрывающийся блок
tabs Переключаемые вкладки
Таблица Сохранение разметки и границ

Код

{
  "renderer": "yfm",
  "runtime": "@diplodoc/transform/dist/js/yfm.js",
  "safeDefault": true
}

Изображение

Схема потока рендера

Термины

Текущий рендер также понимает встроенные термины, если определение добавлено внизу страницы.

Ограничения и нюансы

  • Определение термина ([*id]: текст) должно находиться в самом низу страницы одним блоком, иначе ссылка [термин](*id) не разрешится.
  • Изображения размещаются в директории public/ и подключаются по абсолютному пути /uploads/....
  • Блок tabs чувствителен к отступам: пункты списка должны идти с двумя пробелами перед вложенным контентом, иначе вкладка не отделится от заголовка.
  • Безопасный режим (safeDefault: true) включён по умолчанию — произвольный HTML в Markdown отключён, добавляйте только YFM-директивы.
  • Совместимость — полная поддержка блоков гарантируется при использовании @diplodoc/transform зафиксированной версии; ручная правка HTML в обход рендера не рекомендуется.

Связанные статьи

Единый формат статьи, который одинаково удобен для публичного сайта, будущего редактора и LLM-rewrite pipeline.