Diplodoc CLI (yfm-docs)
yfm-docs
CLI платформы Diplodoc для сборки документации на Yandex Flavored Markdown с навигацией и мультиязычностью
- 123 ★ репозитория
- Последний коммит
- MIT
Расширенный доступ
Почему такой уровень
- Запускает Node-утилиту yfm, которая собирает документацию и пишет результат на диск
- VCS-коннектор ходит в GitHub по токену из .env или .yfm
Установка
- Работает в
В терминале, через SkillFoxx CLI
npx skillfoxx add cli/yfm-docsОпределит агенты на машине, покажет уровень доступа и зафиксирует версию.
Другие способы установки
Доступ и проверки
Как мы проверяемРасширенный доступИнструмент запускает код или ходит в сеть, а внешние данные только читает.
- Запускает Node-утилиту yfm, которая собирает документацию и пишет результат на диск
- VCS-коннектор ходит в GitHub по токену из .env или .yfm
Это чужой код. Посмотрите файлы в репозитории перед установкой.
Что делает
Пакет @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.
Частые вопросы
Как получить только контент без служебного вывода?
Добавьте флаг --raw к yfm content: в stdout попадет только результат без маркеров и баннеров.
Чем отличаются шаблоны minimal и full?
full дополнительно создает presets.yaml, pc.yaml и расширенный .yfm с настройками pdf, поиска, vcs и авторов.
Обсуждение
Вопросов и отзывов пока нет.
Похожие
CLI-инструментыСкилл и CLI от Firecrawl: агент переводит Word, PowerPoint, Excel, OpenDocument, RTF, EPUB, CSV и PDF в Markdown на вашей машине
Четыре плагина Claude Code от Mintlify: чтение чужой документации, соавторство, автономное письмо с запросом на слияние и проверка текстов по стилю
MCP-сервер на базе pandoc: агент конвертирует Markdown, HTML, DOCX, LaTeX, EPUB, ODT и другие форматы друг в друга
Скилл-конвейер документов: что угодно в markdown, markdown в аккуратный html и docx уровня издательства, html обратно в markdown
Скилл и CLI превращают Markdown в DOCX, PDF, PPTX, XLSX, PNG и еще десяток форматов, все считается локально
MCP-сервер для Yandex Wiki на базе пакета ya-wiki-api: 36 инструментов для страниц, гридов, вложений и кеша дерева разделов
Коротко о README
yfm-docs собирает документационные проекты с навигацией и поддержкой YFM. README описывает установку через npm, команду yfm init с интерактивным мастером и флагами и команду yfm content для обработки одного файла. Приведены опции, структура создаваемых файлов и настройка VCS-коннектора. Проект распространяется под MIT и имеет русскую версию README.