DocPlatform Community Edition

DocPlatform — это самостоятельно размещаемая платформа документации, которая сочетает функциональный веб-редактор с двунаправленной синхронизацией git, упакованная в единый бинарный файл без внешних зависимостей.

Пишите в браузере. Отправляйте из IDE. Все остается синхронизированным.

Почему DocPlatform

Платформы документации заставляют выбирать: красивый веб-редактор с привязкой к вендору или файлы в git без инструментов для совместной работы. DocPlatform устраняет этот компромисс.

Для кого предназначен

DocPlatform Community Edition создан для:

• Мейнтейнеров open-source проектов, которые хранят документацию в репозитории, но хотят более удобный UX редактирования, чем работа с Markdown напрямую в GitHub
• Внутренних платформенных / DevEx команд, которым нужен docs-as-code с контролем доступа и веб-редактором — а не что-то одно из двух
• Небольших агентств разработки, управляющих документацией нескольких клиентов с git-бэкапом и без доступной self-hosted альтернативы
• Технических писателей, которым нужен качественный инструмент для написания документации с контролем версий
• Индивидуальных разработчиков, которые хотят личную базу знаний с публичной публикацией — без подписки

Не для: крупных предприятий с требованиями compliance, требующих SAML/SCIM (см. будущую Enterprise Edition), или нетехнических контент-команд без опыта работы с git.

Как это работает

┌──────────────────────────────────────────────────┐
│              DocPlatform (single binary)          │
│                                                  │
│   ┌────────────┐  ┌──────────┐  ┌────────────┐  │
│   │ Web Editor  │  │ SQLite   │  │ Bleve      │  │
│   │ (Next.js)   │  │ Database │  │ Search     │  │
│   └──────┬──────┘  └────┬─────┘  └──────┬─────┘  │
│          │              │               │        │
│          └──────┬───────┴───────┬───────┘        │
│                 │               │                │
│          ┌──────▼──────┐ ┌─────▼──────┐         │
│          │ Content     │ │ Git        │         │
│          │ Ledger      │ │ Engine     │         │
│          └──────┬──────┘ └─────┬──────┘         │
│                 │              │                 │
└─────────────────┼──────────────┼─────────────────┘
                  │              │
           ┌──────▼──────┐ ┌────▼──────┐
           │ Filesystem  │ │ Remote    │
           │ (.md files) │ │ Git Repo  │
           └─────────────┘ └───────────┘

Каждое изменение контента — будь то из веб-редактора, git push или API-вызова — проходит через Content Ledger, единый конвейер, который поддерживает идеальную синхронизацию между файловой системой, базой данных и поисковым индексом.

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

Запустите DocPlatform менее чем за 5 минут:

# Download the binary (recommended — auto-detects platform)
curl -fsSL https://valoryx.org/install.sh | sh

# Initialize a workspace
docplatform init --workspace-name "My Docs" --slug my-docs

# Start the server
docplatform serve

Откройте http://localhost:3000 и зарегистрируйте первого пользователя — он автоматически станет Super Admin.

Полное руководство смотрите в разделе Начало работы.

Обзор возможностей

Основная платформа

• Функциональный веб-редактор — редактор на базе Tiptap с формой frontmatter, переключением в режим Markdown и автосохранением
• Двунаправленная синхронизация git — Web -> git commit -> push; CLI push -> polling -> обновление в вебе
• Обнаружение конфликтов — оптимистичная конкурентность на основе хешей с возможностью скачать diff при коллизии
• Полнотекстовый поиск — встроенный движок Bleve с фильтрацией результатов по правам доступа и сочетанием Cmd+K
• RBAC-права — 5 ролей: Super Admin, Admin, Editor, Commenter, Viewer
• Аутентификация — локальная (argon2id) + опциональный Google/GitHub OIDC
• Модель workspace — Org -> Workspace -> Pages иерархия с приглашениями в команду
• Журнал аудита — каждая мутация логируется с указанием пользователя, временной метки и типа операции

Опубликованная документация

• Публичный сайт — документация доступна по адресу /p/{workspace-slug}/{page-path}
• Темная тема — автоматическая светлая/темная тема с ручным переключением
• 7 встроенных компонентов — Callout, Code (200+ языков), Tabs, Accordion, Cards, Steps, API Block
• Готовность к SEO — теги OpenGraph, канонические URL, sitemap.xml, robots.txt

Эксплуатация

• Диагностика — 9-точечная команда doctor проверяет консистентность FS/DB, работу поиска, битые ссылки
• Ежедневные резервные копии — автоматическое резервное копирование SQLite с настраиваемым сроком хранения
• Корректное завершение работы — обработка сигналов для обновлений без простоя
• Структурированное логирование — JSON-логи с идентификаторами запросов для наблюдаемости

Системные требования

Что дальше

Производительность

Измерено на Apple M2, NVMe SSD, workspace с 1 000 страниц:

Сравнение DocPlatform

Ограничения Community Edition

Community Edition — это полнофункциональное, самостоятельно размещаемое ядро DocPlatform. Оно включает все, что описано на этом сайте, со следующими ограничениями:

Эти ограничения покрывают потребности большинства малых и средних команд. Будущая Enterprise Edition предложит неограниченное количество редакторов и workspaces, SAML/SSO, поддержку PostgreSQL и расширенный поиск через Meilisearch — но Community Edition всегда останется полноценной, самостоятельно размещаемой основой.