Плагины в Diplodoc
Diplodoc предоставляет расширенные возможности разметки Markdown с помощью системы плагинов. Плагины позволяют дополнять базовый синтаксис CommonMark Spec уникальными элементами разметки и новыми возможностями для ваших технических и проектных документов.
Доступны два типа плагинов:
- Предустановленные плагины – встроены в Diplodoc. Часть из них активируется по умолчанию, часть можно включить при необходимости.
- Внешние плагины – могут быть скачаны, установлены отдельно и затем подключены к вашему проекту.
Diplodoc использует парсер markdown-it, поэтому вы можете подключить любой плагин из списка плагинов для markdown-it.
Отличие встроенных от внешних плагинов в том, что первые нужно только подключить в конфигурации, а вторые — сначала установить через менеджер пакетов npm, а затем подключить.
Как подключить плагины
В Diplodoc одним из способов подключения плагинов является использование встроенного расширения mdit-plugins, управление которым осуществляется через файл конфигурации .yfm вашего проекта. Вам достаточно добавить или изменить секцию extensions следующим образом:
extensions:
- name: mdit-plugins # включаем встроенное в CLI расширение для подключения плагинов к markdown-it
plugins:
- "имя плагина" # если у плагина нет параметров - можно указать его имя строкой
- name: "имя плагина" # если у плагина есть какие-то параметры или нужно что-то еще прописать, тогда используется полная форма передачи
options: #...список опций плагина, которые у каждого могут отличаться...
Если плагин экспортирует свой код не через export default, а через именованный экспорт — например, export const somename = ..., — укажите имя такого экспорта в поле exportName. Например, для markdown-it-emoji (у которого несколько вариантов экспорта: full, light, bare) потребуется явно указать нужный экспорт:
extensions:
- name: mdit-plugins
plugins:
- name: markdown-it-emoji
exportName: full # Доступные значения: full, light, bare
Подробней про подключение плагинов читайте в разделах: