Расширения Diplodoc

Статья создана

Обновлена 14 ноября 2025 г.

Расширения предназначены для дополнения функциональности Diplodoc новыми возможностями.

Установка

Перед использованием расширения его необходимо загрузить. Это можно сделать с использованием npm через команду npm install ... или сохранив локально файлы расширения, что подходит – в том числе – для использования расширений собственной разработки.

Пример — установка расширения для подключения Algolia:

npm install @diplodoc/algolia-extension

Подключение

Подключить расширение к проекту можно одним из двух способов:

Прописав его в .yfm проекта в параметре extensions:

extensions:
    - @diplodoc/algolia-extension
    - /local/path/to/extension

Передав через параметр -e при вызове yfm:
```
yfm build -e @diplodoc/algolia-extension
```

Примечание

Если расширение прописано для подключения, но недоступно, команда yfm будет выполнена с ошибкой.

Если расширение не подключено при выполнении команды yfm, но необходимо для корректной обработки проекта, команда yfm может быть выполнена с корректным кодом ответа, но с непредсказуемым результатом.

Встроенные расширения

В Diplodoc встроено несколько расширений в качестве примеров работы Extensions API:

Название	Описание
`github-vcs`	Получает информацию о дате изменения и авторах из репозитория Github при сборке проекта для размещения в контенте статей.
`local-search`	Добавляет в проект локальный поиск на базе lunr.js.
`mdit-plugins`	Добавляет в парсер markdown-it дополнительные плагины для расширения возможностей разметки документации.

Была ли статья полезна?

Подключение CSS

Плагины