Дополнительные плагины
YFM использует markdown-it в качестве парсера, поэтому вы можете подключить любой плагин из списка плагинов для markdown-it.
Подключение
Перед подключением установите пакет с нужным плагином с помощью команды npm i <имя_плагина>. Например, чтобы установить markdown-it-emoji, выполните:
npm i markdown-it-emoji
Важно
При переопределении параметра plugins необходимо заново подключать плагины YFM. Для этого импортируйте их из пакета @diplodoc/transform и передайте в массиве плагинов.
-
Подключите плагин в своем коде, используя функцию
require()илиimport():const plugin1 = require('<имя_плагина>'); -
В параметре
pluginsдобавьте новый плагин в массив:const {result: {html, meta}, logs} = transform(content, {plugins: [<имя_плагина>]});
Пример:
const fs = require('fs');
const transform = require('@diplodoc/transform');
const cut = require('@diplodoc/transform/lib/plugins/cut');
const sup = require('@diplodoc/transform/lib/plugins/sup');
const emoji = require('markdown-it-emoji');
const content = fs.readFileSync(filePath, 'utf');
const {result: {html, meta}, logs} = transform(content, {plugins: [cut, sup, emoji]});
- Перенесите установленный плагин в папку
./pluginsв пакете@diplodoc/cli.
Совет
Чтобы не переносить необходимые плагины перед каждой сборкой, соберите собственный Builder:
- Установите исходный код с GitHub.
- Перенесите дополнительные плагины в папку
./plugins. - Соберите Builder по инструкции с GitHub.
Передача параметров
YFM применяет неизвестные параметры из объекта options ко всем плагинам, поэтому для передачи параметров добавьте их в объект options.