Diplodoc CLI (yfm-docs)
yfm-docs
CLI платформы Diplodoc для сборки документации на Yandex Flavored Markdown с навигацией и мультиязычностью
Установка
npm i @diplodoc/cli -gНужен Node.js 22+
Это чужой код. Посмотрите файлы в репозитории перед установкой.
Что делает
Пакет @diplodoc/cli собирает полноценный проект документации с навигацией и поддержкой Yandex Flavored Markdown. Команда yfm init создает каркас проекта с toc.yaml, index.md и настройками, в том числе для нескольких языков. Команда yfm content обрабатывает один Markdown-файл и выводит результат в md или HTML-фрагмент, а флаг --raw отдает чистый контент без служебных баннеров, что удобно для агентов и пайплайнов.
Для кого. Техническим писателям и разработчикам, которые ведут документацию в формате docs as code.
Подходит, если
- Запускаете новый портал документации на YFM
- Нужна документация на русском и английском в одном проекте
- Агенту нужно отрендерить одну страницу с инклюдами и переменными, не собирая весь проект
- Хотите падать в CI на предупреждениях через --strict
Не подходит, если
- Документация уже живет на другом генераторе и миграция не планируется
- Окружение не позволяет Node.js 22 и выше
Пример запроса к агенту
Создай проект документации Diplodoc с языками ru и en и шаблоном full, затем отрендери index.md в HTMLОграничения
Требуется Node.js 22+. yfm content обрабатывает один файл и для HTML выдает только фрагмент без оглавления и шапки. Подключение VCS-коннектора требует токена GitHub в .env или .yfm.
Как отключить. Удалите глобальный пакет командой npm uninstall -g @diplodoc/cli.
Проверка безопасности
- Работает с локальными файлами документации
- VCS-коннектор использует токен GitHub, если его настроить
Коротко о README
yfm-docs собирает документационные проекты с навигацией и поддержкой YFM. README описывает установку через npm, команду yfm init с интерактивным мастером и флагами и команду yfm content для обработки одного файла. Приведены опции, структура создаваемых файлов и настройка VCS-коннектора. Проект распространяется под MIT и имеет русскую версию README.
Частые вопросы
Как получить только контент без служебного вывода?
Добавьте флаг --raw к yfm content: в stdout попадет только результат без маркеров и баннеров.
Чем отличаются шаблоны minimal и full?
full дополнительно создает presets.yaml, pc.yaml и расширенный .yfm с настройками pdf, поиска, vcs и авторов.
Похожие
Скиллы Anthropic
Skills
Официальные примеры скиллов Anthropic: документы docx, pdf, pptx, xlsx, дизайн, MCP builder и спецификация Agent Skills
Набор скиллов для Claude Code: исследование, написание статьи, рецензирование и проверка цитат по шагам
Превращает техническую книгу или папку документов в структурированный скилл с главами, глоссарием и шпаргалкой
Скилл для редактируемых диаграмм draw.io из текста, кода, Terraform, Kubernetes, SQL и OpenAPI с экспортом и самопроверкой