DocPlatform Community Edition

DocPlatform est une plateforme de documentation auto-hébergée qui combine un éditeur web riche avec une synchronisation git bidirectionnelle — le tout dans un binaire unique, sans aucune dépendance externe.

Écrivez dans votre navigateur. Poussez depuis votre IDE. Tout reste synchronisé.

Pourquoi DocPlatform

Les plateformes de documentation vous obligent à choisir : un éditeur web soigné avec un verrouillage fournisseur, ou des fichiers bruts dans git sans fonctionnalités de collaboration. DocPlatform élimine ce compromis.

À qui s’adresse-t-il

DocPlatform Community Edition est conçu pour :

• Les mainteneurs open source qui conservent la documentation de leur projet dans le dépôt mais souhaitent une meilleure expérience d’édition que le Markdown brut sur GitHub
• Les équipes plateforme interne / DevEx qui ont besoin de docs-as-code avec contrôle d’accès et un éditeur web — pas l’un ou l’autre
• Les petites agences de développement gérant plusieurs dépôts de documentation clients avec sauvegarde git et aucune option auto-hébergée abordable
• Les rédacteurs techniques qui ont besoin d’une expérience de rédaction soignée, adossée au contrôle de version
• Les développeurs solo qui souhaitent une base de connaissances personnelle avec publication publique — sans abonnement

Ne cible pas : les entreprises soumises à de fortes contraintes de conformité nécessitant SAML/SCIM (voir la future Enterprise Edition), ni les équipes de contenu non techniques sans familiarité avec git.

Comment ça fonctionne

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

Chaque modification de contenu — qu’elle provienne de l’éditeur web, d’un push git ou d’un appel API — passe par le Content Ledger, un pipeline unique qui maintient le système de fichiers, la base de données et l’index de recherche en parfaite synchronisation.

Démarrage rapide

Lancez DocPlatform en moins de 5 minutes :

# Télécharger le binaire (recommandé — détection automatique de la plateforme)
curl -fsSL https://valoryx.org/install.sh | sh

# Initialiser un espace de travail
docplatform init --workspace-name "My Docs" --slug my-docs

# Démarrer le serveur
docplatform serve

Ouvrez http://localhost:3000 et enregistrez votre premier utilisateur — il devient automatiquement Super Admin.

Pour le guide complet, consultez le guide Premiers pas.

Aperçu des fonctionnalités

Plateforme principale

• Éditeur web riche — Éditeur basé sur Tiptap avec formulaire de frontmatter, bascule Markdown brut et sauvegarde automatique
• Synchronisation git bidirectionnelle — Web → commit git → push ; push CLI → polling → mise à jour web
• Détection des conflits — Concurrence optimiste basée sur les hash avec diff téléchargeable en cas de collision
• Recherche plein texte — Moteur Bleve intégré avec résultats filtrés par permissions et raccourci Cmd+K
• Permissions RBAC — 5 rôles : Super Admin, Admin, Editor, Commenter, Viewer
• Authentification — Locale (argon2id) + OIDC optionnel Google/GitHub
• Modèle d’espace de travail — Hiérarchie Org → Workspace → Pages avec invitations d’équipe
• Journal d’audit — Chaque modification enregistrée avec utilisateur, horodatage et type d’opération

Documentation publiée

• Site public — Servez vos docs à /p/{workspace-slug}/{page-path}
• Mode sombre — Thème clair/sombre automatique avec bascule manuelle
• 7 composants intégrés — Callout, Code (200+ langages), Tabs, Accordion, Cards, Steps, API Block
• Prêt pour le SEO — Balises OpenGraph, URLs canoniques, sitemap.xml, robots.txt

Opérations

• Diagnostics de santé — Commande doctor à 9 points vérifiant la cohérence FS/DB, la santé de la recherche et les liens cassés
• Sauvegardes quotidiennes — Sauvegardes SQLite automatisées avec rétention configurable
• Arrêt gracieux — Gestion propre des signaux pour des déploiements sans interruption
• Journalisation structurée — Logs JSON avec identifiants de requête pour l’observabilité

Configuration requise

Et ensuite

Performances

Mesurées sur Apple M2, SSD NVMe, espace de travail de 1 000 pages :

Comparaison de DocPlatform

Limites de la Community Edition

La Community Edition est le noyau complet et auto-hébergeable de DocPlatform. Elle inclut tout ce qui est documenté sur ce site, avec les limites suivantes :

Ces limites couvrent la majorité des petites et moyennes équipes. La future Enterprise Edition offrira un nombre illimité d’éditeurs, d’espaces de travail, le support SAML/SSO, PostgreSQL et la recherche avancée via Meilisearch — mais la Community Edition restera toujours la fondation complète et auto-hébergeable.