DocPlatform Community Edition

DocPlatform is a self-hosted documentation platform that combines a rich web editor with bidirectional git synchronization — packaged as a single binary with zero external dependencies.

Write in your browser. Push from your IDE. Everything stays in sync.

Why DocPlatform

Documentation platforms force you to choose: a polished web editor with vendor lock-in, or raw files in git with no collaboration features. DocPlatform eliminates that trade-off.

Who it’s for

DocPlatform Community Edition is built for:

• Open-source maintainers who keep project docs in-repo but want better editing UX than raw Markdown in GitHub
• Internal platform / DevEx teams who need docs-as-code with access control and a web editor — not one or the other
• Small dev agencies managing multiple client docs repos with git backup and no affordable self-hosted option
• Technical writers who need a polished authoring experience backed by version control
• Solo developers who want a personal knowledge base with public publishing — without a subscription

Not targeting: compliance-heavy enterprises requiring SAML/SCIM (see future Enterprise Edition), or non-technical content teams without git familiarity.

How it works

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

Every content change — whether from the web editor, a git push, or an API call — flows through the Content Ledger, a single pipeline that keeps the filesystem, database, and search index in perfect sync.

Quick start

Get DocPlatform running in under 5 minutes:

# 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

Open http://localhost:3000 and register your first user — they automatically become the Super Admin.

For the complete walkthrough, see the Getting Started guide.

Feature overview

Core platform

• Rich web editor — Tiptap-based editor with frontmatter form, raw Markdown toggle, and autosave
• Bidirectional git sync — Web → git commit → push; CLI push → polling → web update
• Conflict detection — Hash-based optimistic concurrency with downloadable diff on collision
• Full-text search — Embedded Bleve engine with permission-filtered results and Cmd+K shortcut
• RBAC permissions — 5 roles: Super Admin, Admin, Editor, Commenter, Viewer
• Authentication — Local (argon2id), Google/GitHub OIDC, and WebAuthn/Passkeys
• Workspace model — Org → Workspace → Pages hierarchy with team invitations
• Audit trail — Every mutation logged with user, timestamp, and operation type
• Doc versioning — Named versions (v1, v2) with default version selection
• Doc quality scanner — Readability scoring, dead link detection, and completeness checks
• Templates — Pre-built page templates for common documentation patterns

Published documentation

• Public site — Serve docs at /p/{workspace-slug}/{page-path}
• 7 themes — Default, Dark, Forest, Rose, Amber, Minimal, Corporate
• 15+ built-in components — Callout, Code (200+ languages), Tabs, Accordion, Cards, Steps, API Block, File Tree, Mermaid diagrams, KaTeX math, and more
• SEO ready — OpenGraph tags, canonical URLs, sitemap.xml, robots.txt, RSS feed
• Custom domains — Serve docs on your own domain with auto-TLS via Caddy integration
• Static export — Export workspace as a static HTML ZIP for CDN deployment

AI features

• Writing assist — Rewrite, improve, shorten, or expand selected content using Claude or OpenAI
• Doc chat — Multi-turn conversation about your workspace documentation
• MCP server (13 tools) — Built-in Model Context Protocol server. Connect Claude Code, Claude Desktop, or Cursor to read, write, search, and maintain your docs autonomously via stdio
• Context Graph API — Structured knowledge graph for AI agents to navigate page relationships, tags, and wikilinks

Analytics & billing

• Pageview analytics — Track page views and top pages with GDPR-compliant cookie consent
• Search analytics — Monitor search queries, top searches, and search frequency
• Stripe billing — Community (free, unlimited), Free (1 workspace, 3 editors), Team ($29/mo), Business ($79/mo) with annual pricing (2 months free)
• Feature gating — Analytics, custom domains, and advanced AI locked to paid plans
• 14-day free trial — Configurable trial period for paid plans

Operations

• Health diagnostics — 10-point doctor command checks FS/DB consistency, search health, broken links
• Daily backups — Automated SQLite backups with configurable retention
• Graceful shutdown — Clean signal handling for zero-downtime deployments
• Structured logging — JSON logs with request IDs for observability
• Durable job queue — DB-backed async processing with retries for search indexing and maintenance
• Super admin dashboard — Org/user management, impersonation, audit log, system health, GDPR tools
• Prometheus metrics — Optional /metrics endpoint for monitoring integration
• Static site export — Export and preview published docs locally

System requirements

What’s next

Performance

Measured on Apple M2, NVMe SSD, 1,000-page workspace:

How DocPlatform compares

Community Edition limits

Community Edition is the fully functional, self-hosted core of DocPlatform. It includes everything documented on this site with the following limits:

Community Edition has no artificial limits. Future Enterprise Edition will offer SAML/SSO, PostgreSQL support, and advanced search via Meilisearch — but Community Edition will always remain the complete, self-hostable foundation.