DocPlatform Community Edition

DocPlatform ist eine selbst gehostete Dokumentationsplattform, die einen leistungsfähigen Web-Editor mit bidirektionaler Git-Synchronisation kombiniert — verpackt als einzelne Binärdatei ohne externe Abhängigkeiten.

Schreiben Sie im Browser. Pushen Sie aus Ihrer IDE. Alles bleibt synchron.

Warum DocPlatform

Dokumentationsplattformen zwingen Sie zu einer Entscheidung: ein ausgefeilter Web-Editor mit Herstellerbindung oder Rohdateien in Git ohne Kollaborationsfunktionen. DocPlatform beseitigt diesen Kompromiss.

Für wen es gedacht ist

DocPlatform Community Edition ist konzipiert für:

• Open-Source-Maintainer, die Projektdokumentation im Repository führen, aber eine bessere Bearbeitungserfahrung als rohes Markdown in GitHub wünschen
• Interne Plattform- / DevEx-Teams, die Docs-as-Code mit Zugriffskontrolle und Web-Editor benötigen — nicht das eine oder das andere
• Kleine Entwicklungsagenturen, die mehrere Kundendokumentations-Repositories mit Git-Backup verwalten und keine bezahlbare selbst gehostete Option haben
• Technische Redakteure, die eine ausgefeilte Autorenerfahrung mit Versionskontrolle benötigen
• Einzelentwickler, die eine persönliche Wissensdatenbank mit öffentlicher Veröffentlichung möchten — ohne Abonnement

Nicht die Zielgruppe: Compliance-intensive Unternehmen, die SAML/SCIM benötigen (siehe zukünftige Enterprise Edition), oder nicht-technische Content-Teams ohne Git-Erfahrung.

Wie es funktioniert

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

Jede Inhaltsänderung — ob über den Web-Editor, einen Git-Push oder einen API-Aufruf — durchläuft das Content Ledger, eine zentrale Pipeline, die Dateisystem, Datenbank und Suchindex in perfekter Synchronisation hält.

Schnellstart

DocPlatform in unter 5 Minuten zum Laufen bringen:

# Binary herunterladen (empfohlen — erkennt die Plattform automatisch)
curl -fsSL https://valoryx.org/install.sh | sh

# Einen Workspace initialisieren
docplatform init --workspace-name "My Docs" --slug my-docs

# Server starten
docplatform serve

Öffnen Sie http://localhost:3000 und registrieren Sie Ihren ersten Benutzer — dieser wird automatisch zum Super Admin.

Die vollständige Anleitung finden Sie im Erste Schritte-Leitfaden.

Funktionsübersicht

Kernplattform

• Leistungsfähiger Web-Editor — Tiptap-basierter Editor mit Frontmatter-Formular, Raw-Markdown-Umschalter und automatischem Speichern
• Bidirektionale Git-Synchronisation — Web → Git-Commit → Push; CLI-Push → Polling → Web-Aktualisierung
• Konflikterkennung — Hash-basierte optimistische Nebenläufigkeit mit herunterladbarem Diff bei Kollisionen
• Volltextsuche — Eingebettete Bleve-Engine mit berechtigungsgefilterten Ergebnissen und Cmd+K-Tastenkürzel
• RBAC-Berechtigungen — 5 Rollen: Super Admin, Admin, Editor, Commenter, Viewer
• Authentifizierung — Lokal (argon2id) + optionales Google/GitHub OIDC
• Workspace-Modell — Organisation → Workspace → Seitenhierarchie mit Team-Einladungen
• Audit-Trail — Jede Mutation wird mit Benutzer, Zeitstempel und Operationstyp protokolliert

Veröffentlichte Dokumentation

• Öffentliche Seite — Dokumentation unter /p/{workspace-slug}/{page-path} bereitstellen
• Dark Mode — Automatisches helles/dunkles Farbschema mit manuellem Umschalter
• 7 integrierte Komponenten — Callout, Code (200+ Sprachen), Tabs, Accordion, Cards, Steps, API Block
• SEO-fähig — OpenGraph-Tags, kanonische URLs, sitemap.xml, robots.txt

Betrieb

• Diagnosefunktionen — 9-Punkte-doctor-Befehl prüft FS/DB-Konsistenz, Suchstatus, defekte Links
• Tägliche Backups — Automatisierte SQLite-Backups mit konfigurierbarer Aufbewahrungsdauer
• Kontrolliertes Herunterfahren — Saubere Signalbehandlung für Deployments ohne Ausfallzeit
• Strukturiertes Logging — JSON-Logs mit Request-IDs für Observability

Systemanforderungen

Nächste Schritte

Leistung

Gemessen auf Apple M2, NVMe SSD, 1.000-Seiten-Workspace:

Wie DocPlatform im Vergleich abschneidet

Community Edition Limits

Die Community Edition ist der voll funktionsfähige, selbst gehostete Kern von DocPlatform. Sie umfasst alles, was auf dieser Seite dokumentiert ist, mit folgenden Einschränkungen:

Diese Limits decken die Mehrheit kleiner bis mittlerer Teams ab. Die zukünftige Enterprise Edition wird unbegrenzte Editoren, unbegrenzte Workspaces, SAML/SSO, PostgreSQL-Unterstützung und erweiterte Suche über Meilisearch bieten — aber die Community Edition wird immer die vollständige, selbst hostbare Grundlage bleiben.