Плагины

Кроме базового синтаксиса CommonMark Spec, YFM предоставляет набор плагинов с дополнительными возможностями и уникальными элементами разметки.

Важно

Порядок добавления плагинов важен. При добавлении плагинов необходимо указывать полный набор плагинов.

Название плагина

Описание

Параметры

Подключен по умолчанию

Автоматическое генерирование якорей для заголовков

extractTitle: учитывать заголовок первого уровня
Тип: bool, По умолчанию: false

supportGithubAnchors: генерировать дополнительные якоря, совместимые с GitHub
Тип: bool, По умолчанию: false

Отображение кнопки копирования в блоках кода

-

Поддержка разметки катов

-

Поддержка разметки списка определений

-

Поддержка разметки объектов файлов

fileExtraAttrs: дополнительные атрибуты для ссылки

Добавление списка задач

divClass: classname для div, который оборачивает чекбокс
Тип: string, По умолчанию: checkbox

idPrefix: перфикс для id чекбокса
Тип: string, По умолчанию: checkbox

Добавление изображений

assetsPublicPath: путь до иконок
Тип: string, По умолчанию: /

Задание размера изображений

-

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

getVarsPerFile: функция, которая по пути к файлу возвращает вычисленные переменные
Тип: function, По умолчанию: -

Расширение синтаксиса ссылок

-

Моноширинный шрифт

-

Добавление метаданных в начало файлов

-

Поддержка разметки заметок

lang: язык для отображения типа заметки
Тип: string, По умолчанию: ru

Вывод текста в верхнем регистре

-

Поддержка многострочных таблиц

-

Поддержка разметки табов

-

Добавление видео

-

Выше перечислены плагины, включенные в пакет YFM. Но вы можете подключить дополнительные или написать свой плагин, используя руководством от markdown-it.