Führen Sie docmd in jedem Verzeichnis aus, das Markdown-Dateien enthält. Keine Konfigurationsdatei, kein Setup-Overhead oder Framework-Erfahrung erforderlich.
1. Entwicklungsserver starten
npx @docmd/core dev
pnpm dlx @docmd/core dev
yarn dlx @docmd/core dev
bunx @docmd/core dev
Dies öffnet http://localhost:3000. Ihre Dokumentation ist jetzt live.
Wenn Port 3000 derzeit belegt ist, erkennt docmd dies automatisch und bindet sich an den nächsten verfügbaren Port (z. B. 3001).
2. Automatische Funktionsauflösung
Die Engine konfiguriert alle wesentlichen Funktionen automatisch:
- Verzeichniserkennung: Sucht nach
docs/,src/docs/,documentation/,content/oder allen.md-Dateien im Projekt-Root. - Navigationsstrukturierung: Erstellt einen verschachtelten Sidebar-Navigationsbaum direkt aus Ihrer Verzeichnishierarchie.
- Titelauflösung: Extrahiert Seitentitel automatisch aus dem ersten
H1-Überschriften-Tag. - Suchindexierung: Erstellt sofort einen clientseitigen Volltext-Suchindex.
- Smartes Caching: Löst bei Dateispeicherung automatisch Rebuilds in unter 200 ms aus.
Keine docmd.config.json erforderlich. Fügen Sie später eine hinzu, um Layouts, Plugins oder Versionierungseinstellungen anzupassen.
3. Für Produktion bauen
Kompilieren Sie Ihre Markdown-Dateien in eine optimierte, statische Produktions-Website.
npx @docmd/core build
pnpm dlx @docmd/core build
yarn dlx @docmd/core build
bunx @docmd/core build
Der Compiler gibt eine statische Website nach ./site/ aus. Hosten Sie diese statische Ausgabe überall, z. B. auf GitHub Pages, Vercel, Netlify oder jedem statischen HTTP-Host.
Bereit, Ihr Projekt zu konfigurieren? Erfahren Sie im Projektstruktur-Leitfaden, wie Sie Ihr Repository strukturieren, oder erkunden Sie lokale Installationsoptionen unter Installation.