Skip to content

README.ru.md

Latest commit

 

History

History
311 lines (236 loc) · 18.3 KB

README.ru.md

File metadata and controls

311 lines (236 loc) · 18.3 KB
Raw
EN  |  DE  |  中文  |  ES  |  日本語  |  FR  |  RU
docmd

Готовая к продакшену документация из Markdown за считанные секунды.
Нулевая конфигурация. Нативно для ИИ. Создано для разработчиков.

npm версия скачивания в месяц GitHub звезд лицензия

Веб-сайт  ·  Документация  ·  AI Cloud Relay  ·  Онлайн-редактор  ·  Agent Skills  ·  Сообщить об ошибке


Тема по умолчанию docmd — предпросмотр светлого и темного режимов



✦ 0.9 Серия — ИИ, Автоматизация и Безопасность

Линейка 0.9.x — это этап, на котором docmd эволюционирует из генератора документации, готового к ИИ, в полноценную платформу документации, разработанную как для людей, так и для ИИ-агентов.

В этой серии представлен ИИ-ассистент, позволяющий вести диалоговый поиск по документации с использованием собственного провайдера, локального ИИ или docmd Cloud Relay для статических сайтов без собственного бэкенда. Также расширяется ИИ-экосистема docmd благодаря поддержке MCP, сгенерированному контексту для LLM, Agent Skills и структурированным форматам знаний.

Наряду с ИИ, особое внимание уделяется безопасности, конфиденциальности и автоматизации, параллельно с непрерывным улучшением основных функций работы с документацией, поиска, развертывания и рабочих процессов разработчиков.

Следить за дорожной картой 0.9 →

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

Запустите docmd в любой папке с Markdown-файлами — установка не требуется:

npx @docmd/core dev
Открывается по адресу http://localhost:3000
    _                 _ 
  _| |___ ___ _____ _| |
 | . | . |  _|     | . |
 |___|___|___|_|_|_|___|

 v0.9.0

BUILD
  Engine          JS
  Source          docs/
  Output          site/
  Versions        2 (06, 05)
  Locales         7 (en, hi, zh, es, de, ja, fr)

DATA INDEXING
  [ DONE ] Syncing git metadata
  [ DONE ] Building search index & RAG embeddings (multi-version)
  [ DONE ] Generating AI Assistant RAG context

PUBLISHING
  [ DONE ] Generated robots.txt
  [ DONE ] Generated .nojekyll (disables Jekyll on GitHub Pages)
  [ DONE ] Generated sitemap
  [ DONE ] Generating LLMs context files (llms.txt)
  [ DONE ] Generating OKF bundles

⬢ Initial build completed in 1.2s.

WATCHING
  Source          ./docs
  Config          ./docmd.config.json
  Assets          ./assets

DEVELOPMENT SERVER RUNNING
  Local Access    http://127.0.0.1:3000
  Network Access  http://192.168.1.6:3000
  Serving from    ./site

Навигация генерируется автоматически на основе структуры ваших файлов. Не требуется файл конфигурации, frontmatter или изучение сложных фреймворков.

Когда будете готовы к публикации:

npx @docmd/core build

Команда сгенерирует высокооптимизированный статический сайт (SPA), готовый к деплою на Vercel, Cloudflare Pages, Netlify, GitHub Pages или любой статический хостинг.

Требования: Node.js 18+

Или установите глобально / через Docker
# Установка глобально через npm
npm install -g @docmd/core

# Или через pnpm
pnpm add -g @docmd/core

# Запуск
docmd dev    # запуск сервера разработки
docmd build  # сборка для продакшена

Или запуск через Docker:

docker run -p 3000:3000 ghcr.io/docmd-io/docmd:0.9.0

Зафиксируйте версию для воспроизводимых сборок.

Почему docmd?

image

Смотрите полное Сравнение с Docusaurus, Mintlify и другими →

Особенности

Нулевая конфигурация, мгновенный запуск

Укажите docmd на любую папку с Markdown-файлами, и он сразу заработает. Навигация формируется автоматически из структуры файлов. Вы можете написать первый документ и опубликовать его менее чем за минуту — без шаблонов, настройки сборок и предварительных решений.

Минимальный размер, скорость везде

Размер основного JavaScript-кода составляет всего ~18 кб. Страницы переключаются как мгновенное SPA-приложение. На выходе получается статический HTML — оптимизированный для SEO, со встроенными sitemap, каноническими URL и метаданными Open Graph. Офлайн полнотекстовый поиск встроен по умолчанию и не требует сторонних сервисов.

Нативно для ИИ

docmd рассматривает ИИ как первоклассный способ работы с документацией, не заменяя при этом саму документацию.

  • ИИ-ассистент (@docmd/plugin-ai) — RAG-чат по вашей документации. Используйте свой API-ключ или подключайте локального ИИ-провайдера благодаря поддержке 100+ сервисов через AIPlug.
  • Cloud Relay — включайте ИИ-ассистента на статических сайтах без развертывания собственного ИИ-бэкенда. Попробовать →
  • Сервер MCP — docmd mcp предоставляет доступ к документации для ИИ-агентов через stdio, позволяя им искать, читать и проверять содержимое.
  • Контекст (llms.txt / llms-full.txt) — полный контекст документации, генерируемый во время сборки.
  • Agent Skills — модульные наборы инструкций для LLM и агентов IDE.
  • Open Knowledge Format (OKF) — структурированные многоязычные пакеты знаний для ИИ-систем.
  • Копировать как Markdown / Копировать контекст — кнопки извлечения контекста в один клик прямо из браузера.

Готов к масштабированию

  • Мультиязычность с многоязычной сборкой (индивидуальный индекс поиска для каждого языка, llms, okf, hreflang)
  • Версионирование документации (с автоматическим определением текущей версии)
  • Workspaces для монорепозиториев и мультипроектных структур
  • Гибкая система плагинов (проверка типов возвращаемых значений, поддержка async)
  • Кастомизация тем, встроенные шаблоны, собственные CSS/JS, светлый и темный режимы

CLI

docmd dev            # локальный сервер разработки
docmd build          # сборка для деплоя
docmd live           # запуск онлайн-редактора в браузере
docmd init           # создание docmd.config.json в текущей папке
docmd stop           # остановка серверов `docmd dev` / `docmd live`
docmd doctor         # диагностика конфигурации и статуса плагинов
docmd migrate        # миграция с Docusaurus, VitePress, MkDocs или Starlight
docmd deploy         # генерация конфигов для Docker, NGINX, Caddy, Vercel, Netlify
docmd validate       # проверка всех внутренних ссылок и якорей
docmd mcp            # запуск сервера MCP через stdio
docmd add <name>     # установка плагина или шаблона

Плагины

Базовый функционал работает на основе мощной системы плагинов. Основные модули включены по умолчанию, а дополнительные устанавливаются по мере необходимости.

Плагин Статус Описание
ai Базовый RAG ИИ-ассистент с поддержкой BYOK, локальных провайдеров и Cloud Relay
search Базовый Офлайн полнотекстовый поиск (ключевые слова + семантический через docmd-search)
seo Базовый SEO-теги и метаданные Open Graph
sitemap Базовый Генерация sitemap.xml
git Базовый История коммитов Git и даты последнего обновления
analytics Базовый Легкая аналитика посещаемости
llms Базовый Генерация контекста для ИИ (llms.txt / llms-full.txt)
okf Базовый Пакеты Open Knowledge Format для ИИ-агентов (по языкам)
mermaid Базовый Поддержка диаграмм Mermaid
openapi Базовый Рендерер спецификаций OpenAPI 3.x во время сборки
pwa Опциональный Progressive Web App — офлайн навигация
threads Опциональный Встроенные ветки обсуждений (от @svallory)
math Опциональный Рендеринг математических формул KaTeX / LaTeX

Установка опциональных плагинов:

docmd add <имя-плагина>

Создание собственного плагина: Руководство по разработке плагинов

Конфигурация

Конфигурация не требуется для старта. Добавьте docmd.config.json (или .ts / .js) в корень проекта только тогда, когда потребуется точная настройка:

{
  "title": "Мой Проект",
  "url": "https://docs.myproject.com",
  "src": "./docs",
  "out": "./dist"
}

Конфигурационные файлы на TypeScript и JavaScript поддерживаются для динамических значений.

Полный справочник: Обзор конфигурации

Структура проекта

my-docs/
├── docs/                ← Ваши файлы markdown
├── assets/              ← Изображения и статические файлы
├── docmd.config.json    ← Опциональная конфигурация
└── package.json

Онлайн-редактор (Live Editor)

Редактор в браузере для написания и предпросмотра документов — локальная установка не требуется.

Попробуйте на live.docmd.io

Программный API

Используйте docmd в скриптах Node.js, пайплайнах CI или кастомных шагах сборки. (Поддерживает CommonJS и ESM).

import { build } from '@docmd/core';

await build('./docmd.config.json', { isDev: false });

Полный справочник: Node API Reference

Сообщество

Поддержка

  • Рассказать о проекте — лучший способ поддержать развитие docmd. Поделитесь в X с друзьями или поставьте звезду репозиторию.
  • Если docmd экономит ваше время, спонсорство на GitHub будет огромной помощью.
  • Есть идеи или нашли баг? Открывайте issue или PR, а также создавайте собственные плагины.

Лицензия

Лицензия MIT. Смотрите файл LICENSE для подробностей.