README.de.md

^{EN  |  DE  |  中文  |  ES  |  日本語  |  FR  |  RU  |  TR}

Dokumentation für Menschen und Maschinen.
Eine Markdown-Quelle → Website, Suche, KI-Kontext, Agenten und Wissensformate.

Website  ·  Dokumentation  ·  Cloud Relay  ·  Live-Editor  ·  Agent Skills  ·  Issues

Schnellstart

Zeigen Sie docmd auf einen beliebigen Ordner mit Markdown-Dateien:

npx @docmd/core dev

Öffnen Sie http://localhost:3000.

Das ist alles. Die Navigation wird automatisch aus Ihrer Dateistruktur generiert. Keine Konfigurationsdatei, kein Frontmatter und kein Framework erforderlich.

Wenn Sie bereit zum Veröffentlichen sind:

npx @docmd/core build

docmd generiert eine statische Website, die auf Vercel, Cloudflare Pages, Netlify, GitHub Pages, S3, NGINX, Caddy oder jedem anderen statischen Host bereitgestellt werden kann.

Erfordert Node.js 20+.

Globale Installation und Docker

Global installieren:

npm install -g @docmd/core

# oder
pnpm add -g @docmd/core

Dann:

docmd dev
docmd build

Oder mit Docker ausführen:

docker run -p 3000:3000 ghcr.io/docmd-io/docmd:latest

Heften Sie das Docker-Image auf ein bestimmtes Release für reproduzierbare Produktions-Builds an.

Eine Quelle. Jede Ausgabe.

docmd ist ein Open-Source-Dokumentations-Compiler.

Anstatt Ihr Markdown nur als Eingabe für eine Website zu behandeln, kompiliert docmd dieselbe Quelle in Ausgaben für Leser, Suchmaschinen, LLMs, Coding-Agenten und Wissenssysteme.

Markdown
   │
   ▼
 docmd
   │
   ├── → Statische Dokumentationsseite
   ├── → Offline-Suchindex
   ├── → llms.txt / llms-full.txt
   ├── → Open Knowledge Format (OKF)
   ├── → Sitemap + SEO-Metadaten
   ├── → robots.txt + Open Graph
   ├── → MCP-Schnittstelle für KI-Agenten
   └── → KI-Assistenten-Kontext

Ein Quellbaum. Eine Build-Pipeline. Keine getrennten Dokumentations- und KI-Wissens-Stacks zu verwalten.

Warum docmd?

Dokumentation hat zunehmend mehr als einen Leser.

Menschen brauchen eine schnelle, gut navigierbare Website. Suchmaschinen brauchen strukturierte Metadaten. LLMs brauchen sauberen Kontext. Coding-Agenten brauchen Werkzeuge und Protokolle. RAG-Systeme brauchen strukturiertes Wissen.

docmd baut all dies zusammen, während Markdown stets im Mittelpunkt bleibt.

Den vollständigen Vergleich mit Docusaurus, Mintlify und weiteren Dokumentations-Tools ansehen →

Features

Zero Config, sofortiger Start

Zeigen Sie docmd auf einen beliebigen Markdown-Ordner und es läuft. Die Navigation wird automatisch aus Ihrer Dateistruktur generiert — kein Boilerplate, Frontmatter oder Build-Pipeline erforderlich, um loszulegen.

Leichtgewichtig von Haus aus, schnell überall

docmd generiert statisches HTML mit minimalem Vanilla-JavaScript und schneller Navigation im SPA-Stil. Offline-Volltextsuche, Sitemap, kanonische URLs, Open-Graph-Metadaten und weitere Grundlagen sind direkt in der Ausgabe enthalten.

Bereit für KI & Agenten

docmd behandelt maschinenlesbare Dokumentation als Teil des Builds, nicht als separaten Veröffentlichungsprozess.

• KI-Assistent — RAG-gestützter Chat, verankert in Ihrer Dokumentation
• MCP-Server — ermöglicht kompatiblen Coding-Agenten das Suchen, Lesen und Validieren Ihrer Dokumentation
• llms.txt / llms-full.txt — vollständiger, für LLMs lesbarer Dokumentations-Kontext
• Open Knowledge Format (OKF) — strukturierte Wissenspakete für KI- und RAG-Systeme
• Agent Skills — wiederverwendbare Anweisungen für LLMs und Coding-Agenten
• Als Markdown kopieren / Kontext kopieren — saubere Kontextextraktion direkt im Browser
• Semantische Suche — optionale Vektorsuche neben der integrierten Stichwortsuche

Für Skalierbarkeit entwickelt

• Internationalisierung mit sprachabhängiger Suche und generierten Ausgaben
• Versionierung für mehrere Dokumentations-Releases
• Workspaces für Monorepos und Multi-Projekt-Setups
• OpenAPI 3.x-Rendering für API-Dokumentation
• Integrierte Vorlagen, benutzerdefiniertes CSS/JavaScript und Hell-/Dunkelmodus

KI-Assistent & Cloud Relay

docmd enthält einen RAG-gestützten KI-Assistenten, der in Ihrer Dokumentation verankert ist.

Sie können ihn mit Ihrem eigenen Backend oder einem lokalen KI-Anbieter verbinden. Wenn Ihre Dokumentation als statische Website bereitgestellt wird, bietet docmd Cloud Relay stattdessen die gehostete Brücke.

Ihre Dokumentation
        │
        ▼
 @docmd/plugin-ai
        │
        ▼
 docmd Cloud Relay
        │
        ▼
 Ihr KI-Anbieter

Cloud Relay sendet KI-Anfragen sicher an den von Ihnen gewählten Anbieter, sodass keine Zugangsdaten an den Browser übertragen werden müssen und Sie kein eigenes KI-Backend betreiben müssen.

Cloud Relay ist mit Ihrem eigenen KI-Anbieterschlüssel kostenlos nutzbar.

• Bringen Sie Ihren eigenen Anbieter und Ihr eigenes Modell mit
• Halten Sie API-Zugangsdaten vom Client fern
• Funktioniert mit statischem Hosting
• Kein KI-Backend bereitzustellen oder zu warten
• Einblicke in Nutzung und Leserfragen
• Mehrere Dokumentationsprojekte über ein Konto verbinden

Cloud Relay einrichten → • Dokumentation zum KI-Assistenten →

Cloud Relay ist kostenlos. Die Modellnutzung kann von Ihrem gewählten KI-Anbieter separat berechnet werden.

CLI

docmd dev            # Lokalen Entwicklungsserver starten
docmd build          # Für Produktion bauen
docmd live           # Browser-basierten Live-Editor starten
docmd init           # Konfigurationsdatei erstellen
docmd doctor         # Konfiguration und Plugin-Status überprüfen
docmd validate       # Interne Dokumentations-Links prüfen
docmd migrate        # Von Docusaurus, VitePress, MkDocs oder Starlight migrieren
docmd deploy         # Deployment-Konfiguration generieren
docmd mcp            # MCP-Server über stdio ausführen
docmd add <name>     # Plugin oder Template installieren
docmd stop           # Laufende docmd-Entwicklungsserver stoppen

Alle CLI-Befehle ansehen →

Plugins

docmd basiert auf einem Plugin-System. Gängige Dokumentationsfunktionen sind direkt im Kern enthalten, während optionale Plugins bei Bedarf installiert werden können.

Plugin	Status	Beschreibung
ai	Kern	RAG-gestützter KI-Assistent mit BYOK, lokalen Anbietern und Cloud Relay
search	Kern	Offline-Stichwortsuche mit optionaler semantischer Suche
seo	Kern	SEO- und Open-Graph-Metadaten
sitemap	Kern	Generiert sitemap.xml
git	Kern	Git-Historie und Metadaten zur letzten Aktualisierung
analytics	Kern	Schlanke Analytics-Integration
llms	Kern	Generiert llms.txt und llms-full.txt
okf	Kern	Open Knowledge Format Bundles
mermaid	Kern	Mermaid-Diagramm-Rendering
openapi	Kern	OpenAPI 3.x-Dokumentations-Renderer
pwa	Optional	Progressive Web App und Offline-Navigation
threads	Optional	Inline-Diskussions-Threads (von @svallory)
math	Optional	KaTeX- / LaTeX-Rendering

Ein optionales Plugin installieren:

docmd add <plugin-name>

Erstellen Sie Ihr eigenes: Plugin-Entwicklungs-Leitfaden →

Konfiguration

Konfiguration ist optional.

Fügen Sie eine docmd.config.json, docmd.config.ts oder docmd.config.js im Projektstamm hinzu, wenn Sie mehr Kontrolle benötigen:

{
  "title": "Mein Projekt",
  "url": "https://docs.meinprojekt.de",
  "src": "./docs",
  "out": "./dist"
}

TypeScript- und JavaScript-Konfigurationen können verwendet werden, wenn dynamische Werte erforderlich sind.

Konfigurations-Referenz →

Programmatische API

Verwenden Sie docmd aus Node.js-Skripten, CI-Pipelines oder benutzerdefinierten Build-Systemen.

import { build } from '@docmd/core';

// Dokumentation programmatisch bauen.
await build('./docmd.config.json', { isDev: false });

CommonJS und ESM werden unterstützt.

Node-API-Referenz →

Migration

Bestehende Dokumentation muss nicht von Grund auf neu aufgebaut werden.

docmd migrate

Migrations-Tools sind für unterstützte Dokumentations-Frameworks wie Docusaurus, VitePress, MkDocs und Starlight verfügbar.

Dokumentation zur Migration →

Open Source

Ihre Dokumentation ist das intellektuelle Herzstück Ihres Projekts. Sie gehört in einfache Markdown-Dateien in Ihrem Git-Repository — portabel, versionskontrolliert und nachvollziehbar.

Der docmd-Compiler und die offiziellen Kern-Plugins stehen unter der MIT-Lizenz und bleiben dauerhaft kostenlos nutzbar, ohne kostenpflichtige Compiler-Funktionen.

Generierte Dokumentationen können überall gehostet werden und erfordern keine von docmd gehostete Infrastruktur.

Community

• Dokumentation → docs.docmd.io
• Fragen & Ideen → GitHub Discussions
• Bugs & Feature-Anfragen → GitHub Issues
• Beitragen → CONTRIBUTING.md
• Roadmap → GitHub Discussions

docmd unterstützen

Wenn docmd für Sie nützlich ist:

• Vergeben Sie dem Repository einen ⭐
• Teilen Sie es mit anderen, die Dokumentationen erstellen
• Eröffnen Sie Issues, tragen Sie Fehlerbehebungen bei oder entwickeln Sie ein Plugin
• Entwicklung auf GitHub sponsern

Lizenz

MIT-Lizenz. Siehe LICENSE für Details.