Produktionsreife Dokumentation aus Markdown, in Sekunden.
Zero Config. AI-nativ. Für Entwickler gebaut.
In der 0.9.x-Serie erweitert sich docmd von einem KI-bereiten Dokumentationsgenerator zu einer Dokumentationsplattform, die sowohl für Menschen als auch für KI-Agenten entwickelt wurde.
Die Serie führt den KI-Assistenten ein, mit dem Dokumentationen dialogbasiert über Ihren eigenen Anbieter, lokale KI oder den docmd Cloud Relay für statische Websites ohne eigenes Backend abgefragt werden können. Zudem wird das KI-Ökosystem von docmd um MCP, generierten LLM-Kontext, Agent Skills und strukturierte Wissensformate erweitert.
Neben KI konzentriert sich diese Serie auf Sicherheit, Datenschutz und Automatisierung, während die Kernfunktionen für Dokumentation, Suche, Deployment und Entwickler-Workflows kontinuierlich verbessert werden.
Starten Sie docmd in jedem Ordner mit Markdown-Dateien — keine Installation nötig:
npx @docmd/core devÖffnet unter http://localhost:3000
_ _
_| |___ ___ _____ _| |
| . | . | _| | . |
|___|___|___|_|_|_|___|
v0.9.0
BUILD
Engine JS
Source docs/
Output site/
Versions 2 (06, 05)
Locales 7 (en, hi, zh, es, de, ja, fr)
DATA INDEXING
[ DONE ] Syncing git metadata
[ DONE ] Building search index & RAG embeddings (multi-version)
[ DONE ] Generating AI Assistant RAG context
PUBLISHING
[ DONE ] Generated robots.txt
[ DONE ] Generated .nojekyll (disables Jekyll on GitHub Pages)
[ DONE ] Generated sitemap
[ DONE ] Generating LLMs context files (llms.txt)
[ DONE ] Generating OKF bundles
⬢ Initial build completed in 1.2s.
WATCHING
Source ./docs
Config ./docmd.config.json
Assets ./assets
DEVELOPMENT SERVER RUNNING
Local Access http://127.0.0.1:3000
Network Access http://192.168.1.6:3000
Serving from ./siteDie Navigation wird aus Ihrer Verzeichnisstruktur generiert. Keine Config-Datei, kein Frontmatter nötig, kein Framework zu lernen.
Wenn Sie bereit zum Veröffentlichen sind:
npx @docmd/core buildDies erzeugt eine hochoptimierte statische Site (SPA), bereit für das Deployment zu Vercel, Cloudflare Pages, Netlify, GitHub Pages oder jedem beliebigen Static Host.
Anforderungen: Node.js 18+
Oder global installieren / per Docker
# Global via npm installieren
npm install -g @docmd/core
# Oder via pnpm
pnpm add -g @docmd/core
# Ausführen
docmd dev # Dev-Server starten
docmd build # Für Deployment bauenOder per Docker:
docker run -p 3000:3000 ghcr.io/docmd-io/docmd:0.9.0Versionieren Sie für reproduzierbare Builds.
Vollständiger Vergleich mit Docusaurus, Mintlify und weiteren →
Zeigen Sie docmd auf einen beliebigen Markdown-Ordner und es läuft. Die Navigation wird automatisch aus Ihrer Verzeichnisstruktur erstellt. Sie können Ihre erste Doku schreiben und in unter einer Minute live haben — kein Boilerplate, keine zu konfigurierende Build-Pipeline, keine Vorab-Entscheidungen.
Der Standard-JavaScript-Payload ist ~18 kb. Seiten navigieren als sofortige SPA. Die Ausgabe ist statisches HTML — SEO-optimiert, mit Sitemap, kanonischen URLs und Open-Graph-Metadaten. Offline-Volltextsuche ist eingebaut, kein Cloud-Dienst nötig.
docmd behandelt KI als erstklassige Möglichkeit, Dokumentationen zu konsumieren — ohne die Dokumentation selbst zu ersetzen.
- KI-Assistent (
@docmd/plugin-ai) — RAG-gestützter Chat, basierend auf Ihrer Dokumentation. Nutzen Sie Ihren eigenen API-Schlüssel oder verbinden Sie einen lokalen KI-Anbieter, mit Unterstützung für über 100 Anbieter via AIPlug. - Cloud Relay — aktivieren Sie den KI-Assistenten auf statischen Dokumentationen ohne eigenen KI-Backend-Betrieb. Ausprobieren →
- MCP-Server —
docmd mcpstellt Ihre Doku KI-Agenten über stdio zur Verfügung, damit diese direkt suchen, lesen und Inhalte validieren können. - Kontext (
llms.txt/llms-full.txt) — vollständiger Dokumentations-Kontext, zur Build-Zeit generiert. - Agent Skills — modulare Anleitungs-Sets für LLMs und IDE-Agenten.
- Open Knowledge Format (OKF) — strukturierte, mehrsprachige Wissenspakete für KI-Systeme.
- Als Markdown kopieren / Kontext kopieren — Ein-Klick-Kontextextraktion direkt im Browser.
- Internationalisierung mit Multi-Locale-Builds (Suchindex pro Sprachversion, llms, okf, hreflang)
- Versionierung für mehrere Dokumentations-Releases (mit automatischer Erkennung der aktuellen Version)
- Workspaces für Monorepos und Multi-Projekt-Setups
- Plugin-System zur Erweiterung der Kern-Funktionalität (Rückgabetyp-Validierung pro Hook, async-freundlich)
- Volle Theming-Unterstützung, eingebaute Templates, eigenes CSS/JS, Light/Dark-Mode
docmd dev # lokaler Dev-Server
docmd build # Für Deployment bauen
docmd live # Browser-basierter Live-Editor
docmd init # neue docmd.config.json im aktuellen Ordner anlegen
docmd stop # laufende `docmd dev` / `docmd live` Server stoppen
docmd doctor # Vorab-Check: Konfiguration + Plugin-Installationsstatus
docmd migrate # Import aus Docusaurus, VitePress, MkDocs oder Starlight
docmd deploy # Config für Docker, NGINX, Caddy, Vercel, Netlify generieren
docmd validate # Alle internen Links prüfen
docmd mcp # Als MCP-Server über stdio betreiben
docmd add <name> # Plugin oder Template installierenDie Kern-Funktionalität wird von einem robusten Plugin-System bereitgestellt. Die Grundlagen sind standardmäßig enthalten, optionale Plugins können für spezifische Bedürfnisse hinzugefügt werden.
| Plugin | Status | Beschreibung |
|---|---|---|
ai |
Kern | RAG-gestützter KI-Assistent mit BYOK, lokalen Anbietern und Cloud Relay |
search |
Kern | Offline-Volltextsuche (Schlüsselwörter + optional semantisch via docmd-search) |
seo |
Kern | SEO-Tags und Open-Graph-Metadaten |
sitemap |
Kern | Generiert sitemap.xml |
git |
Kern | Git-Commit-Historie und letzte Aktualisierungsdaten |
analytics |
Kern | Schlanke Analytics-Integration |
llms |
Kern | AI-Kontext-Generierung (llms.txt / llms-full.txt) |
okf |
Kern | Open Knowledge Format Bundles für KI-Agenten (pro Locale) |
mermaid |
Kern | Mermaid-Diagramm-Unterstützung |
openapi |
Kern | Build-Time-OpenAPI-3.x-Spec-Renderer |
pwa |
Optional | Progressive Web App — Offline-Navigation |
threads |
Optional | Inline-Diskussions-Threads (von @svallory) |
math |
Optional | KaTeX / LaTeX-Mathematik-Rendering |
Optionale Plugins installieren:
docmd add <plugin-name>Eigene bauen: Plugin-Entwicklungs-Leitfaden
Keine Konfiguration ist nötig, um zu starten. Fügen Sie eine docmd.config.json (oder .ts / .js) im Projektstamm nur dann hinzu, wenn Sie mehr Kontrolle brauchen:
{
"title": "Mein Projekt",
"url": "https://docs.meinprojekt.de",
"src": "./docs",
"out": "./dist"
}TypeScript- und JavaScript-Konfigurationsdateien werden für dynamische Werte unterstützt.
Vollständige Referenz: Konfigurations-Übersicht
my-docs/
├── docs/ ← Ihre Markdown-Dateien
├── assets/ ← Bilder und statische Dateien
├── docmd.config.json ← Optionale Konfiguration
└── package.json
Ein browserbasierter Editor zum Schreiben und Vorschauen von Doku — kein lokales Setup erforderlich.
Probieren Sie es aus auf live.docmd.io
Verwenden Sie docmd in Node.js-Skripten, CI-Pipelines oder benutzerdefinierten Build-Schritten. (Unterstützt sowohl CommonJS als auch ESM.)
import { build } from '@docmd/core';
await build('./docmd.config.json', { isDev: false });Vollständige Referenz: Node-API
- Bugs & Probleme → GitHub Issues
- Fragen & Ideen → Discussions
- Beitragen → CONTRIBUTING.md
- Roadmap → GitHub Discussions
- docmd bekannt zu machen ist der direkteste Weg, seine Entwicklung zu unterstützen. Teilen Sie es auf X mit Freunden oder geben Sie ihm einen Stern.
- Falls docmd Ihnen Zeit spart, hilft ein GitHub-Sponsoring sehr weiter.
- Ideen oder Bugs? Eröffnen Sie ein Issue oder eine PR, gerne auch mit eigenen Plugins.
MIT — siehe LICENSE für Details.