Плагины
Кроме базового синтаксиса CommonMark Spec, YFM предоставляет набор плагинов с дополнительными возможностями и уникальными элементами разметки.
Важно
Порядок добавления плагинов важен. При добавлении плагинов следует указать полный набор плагинов
Название плагина | Описание | Параметры | Подключенпо умолчанию |
---|---|---|---|
Anchors | Автоматическое генерирование якорей для заголовков | extractTitle : учитывать заголовок первого уровня(Тип: bool, По умолчанию: false)supportGithubAnchors : генерировать дополнительные якоря, совместимые с GitHub(Тип: bool, По умолчанию: false) |
+ |
Code | Отображение кнопки копирования в блоках кода | - | + |
Cut | Поддержка разметки катов | - | + |
Deflist | Поддержка разметки списка определений | - | + |
File | Поддержка разметки объектов файлов | fileExtraAttrs : дополнительные атрибуты для ссылки |
+ |
Tasks list | Добавление списка задач | divClass : classname для div который оборачивает чекбокс(Тип: string, По умолчанию: checkbox) idPrefix : перфикс для id чекбокса(Тип: string, По умолчанию: checkbox) |
- |
Images | Добавление изображений | assetsPublicPath : путь до иконок(Тип: string, По умолчанию: /) |
- |
Imsize | Задание размера изображений | - | - |
Includes | Переиспользование контента в документе | getVarsPerFile : функция, которая по пути к файлу возвращает вычисленные переменные(Тип: function, По умолчанию: -) |
- |
Links | Расширение синтаксиса ссылок | - | - |
Monospace | Моноширинный шрифт | - | + |
Meta | Добавление метаданных в начало файлов | - | + |
Notes | Поддержка разметки заметок | lang : язык для отображения типа заметки(Тип: string, По умолчанию: ru) |
+ |
Sup | Вывод текста в верхнем регистре | - | + |
Table | Поддержка многострочных таблиц | - | + |
Tabs | Поддержка разметки табов | - | + |
Video | Добавление видео | - | + |
Выше перечислены плагины, включенные в пакет YFM. Но вы можете подключить дополнительные или написать свой плагин, пользуясь руководством от markdown-it.