Repolode
Предложить
docmd-io

docmd-io/docmd

Компилятор документации в Markdown: превращает исходную папку в статический сайт с офлайн-поиском, llms.txt и контекстом для AI-агентов.

Open source альтернатива:DocusaurusMintlify

Открыть на GitHubСайт
Звёзды
2,528
Форки
144
Открытые issues
2
Последний коммит
3 дня назад

Что это?

docmd — компилятор документации на Node.js. Укажите папку с Markdown-файлами, и он создаст удобный для навигации статический сайт, построив меню по структуре файлов. Чтобы начать работу, не нужны ни файл конфигурации, ни frontmatter. Одна сборка также создаёт офлайн-индекс поиска, sitemap, SEO-метаданные и Open Graph, а также robots.txt.

Из тех же исходных файлов можно получать и машиночитаемые данные. docmd генерирует llms.txt и llms-full.txt, наборы Open Knowledge Format для RAG-систем, а также MCP-сервер, с помощью которого coding-агенты могут искать, читать и проверять документацию. Дополнительный плагин AI Assistant позволяет общаться с документацией в чате на основе RAG — через собственного провайдера или размещённый в облаке Cloud Relay.

Проект поддерживает интернационализацию, версионирование, рабочие пространства монорепозиториев, отображение OpenAPI 3.x, диаграммы Mermaid и систему плагинов. В него входит команда миграции проектов с Docusaurus, VitePress, MkDocs или Starlight. Результат можно развернуть на любом статическом хостинге; компилятор и основные плагины распространяются по лицензии MIT.

Ключевые возможности

  • 01Создаёт статический сайт документации с меню, построенным по структуре файлов
  • 02Офлайн-поиск по всему тексту, sitemap, канонические URL и метаданные Open Graph
  • 03Формирует llms.txt, llms-full.txt и наборы Open Knowledge Format
  • 04MCP-сервер, позволяющий coding-агентам искать, читать и проверять документацию
  • 05Интернационализация, версионирование и рабочие пространства монорепозиториев
  • 06Отображение OpenAPI 3.x и поддержка диаграмм Mermaid

Сценарии использования

  • Публикация документации проекта из существующей папки Markdown без настройки
  • Передача LLM и coding-агентам структурированного контекста из документации
  • Миграция существующего сайта на Docusaurus, VitePress или MkDocs
  • Размещение многоязычной документации API на любом статическом хостинге

Быстрый старт

  1. 1

    Укажите docmd папку с файлами Markdown и запустите сервер разработки

    npx @docmd/core dev
  2. 2

    Соберите статический сайт для развёртывания

    npx @docmd/core build

Что важно знать

  • Требуется Node.js версии 20 или новее.
  • Для работы дополнительных функций, таких как AI Assistant, нужен собственный ключ провайдера ИИ или Cloud Relay; за использование моделей может взиматься отдельная плата.

Темы

#documentation#markdown#static-site-generator#llms-txt#mcp#openapi#i18n#typescript#ai-skills#api

Частые вопросы

Что такое docmd?
Компилятор документации в Markdown: превращает исходную папку в статический сайт с офлайн-поиском, llms.txt и контекстом для AI-агентов. docmd — компилятор документации на Node.js. Укажите папку с Markdown-файлами, и он создаст удобный для навигации статический сайт, построив меню по структуре файлов. Чтобы начать работу, не нужны ни файл конфигурации, ни frontmatter. Одна сборка также создаёт офлайн-индекс поиска, sitemap, SEO-метаданные и Open Graph, а также robots.txt.
docmd можно использовать бесплатно? Какая у него лицензия?
docmd распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
docmd всё ещё поддерживается?
Активно поддерживается. Последний коммит в docmd — 16 окт. 2026 г..
Для чего можно использовать docmd?
Публикация документации проекта из существующей папки Markdown без настройки Передача LLM и coding-агентам структурированного контекста из документации Миграция существующего сайта на Docusaurus, VitePress или MkDocs Размещение многоязычной документации API на любом статическом хостинге
Как установить docmd?
Укажите docmd папку с файлами Markdown и запустите сервер разработки: npx @docmd/core dev Соберите статический сайт для развёртывания: npx @docmd/core build
Где скачать docmd?
Исходный код и инструкции по установке — на GitHub: https://github.com/docmd-io/docmd

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты