DocPlatform Community Edition

DocPlatform — це самостійно розгортувана документаційна платформа, яка поєднує багатофункціональний веб-редактор із двонаправленою синхронізацією git — упакована в єдиний бінарний файл без зовнішніх залежностей.

Пишіть у браузері. Відправляйте з IDE. Все залишається синхронізованим.

Чому DocPlatform

Документаційні платформи змушують вас обирати: відполірований веб-редактор із прив’язкою до постачальника або необроблені файли в git без інструментів для спільної роботи. DocPlatform усуває цей компроміс.

Для кого це

DocPlatform Community Edition створено для:

• Мейнтейнерів проєктів з відкритим кодом, які зберігають документацію проєкту в репозиторії, але хочуть кращий UX редагування, ніж необроблений Markdown на GitHub
• Внутрішніх платформних / DevEx команд, яким потрібна документація-як-код з контролем доступу та веб-редактором — а не щось одне
• Невеликих агенцій розробки, які керують кількома клієнтськими репозиторіями документації з резервним копіюванням через git та без доступного варіанту для самостійного розгортання
• Технічних письменників, яким потрібен відполірований досвід авторства з підтримкою контролю версій
• Індивідуальних розробників, яким потрібна особиста база знань із публічною публікацією — без підписки

Не орієнтовано на: великі підприємства з вимогами до 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 — Веб → git commit → push; CLI push → polling → оновлення в вебі
• Виявлення конфліктів — оптимістичне управління паралельністю на основі хешів із завантажуваним diff при колізії
• Повнотекстовий пошук — вбудований рушій Bleve з результатами, відфільтрованими за правами доступу, та ярликом Cmd+K
• Права доступу RBAC — 5 ролей: Super Admin, Admin, Editor, Commenter, Viewer
• Автентифікація — локальна (argon2id) + опціональна Google/GitHub OIDC
• Модель робочих просторів — Організація → Робочий простір → Сторінки з командними запрошеннями
• Журнал аудиту — кожна мутація логується із зазначенням користувача, часу та типу операції

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

• Публічний сайт — подача документації за адресою /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, робочий простір на 1 000 сторінок:

Порівняння DocPlatform

Обмеження Community Edition

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

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