Führen Sie docmd in jedem Ordner aus, der Markdown-Dateien enthält. Keine Konfigurationsdatei, kein Setup, keine Framework-Kenntnisse erforderlich.

1. Entwicklungsserver starten

npm
Bun
npx @docmd/core dev
bunx @docmd/core dev

Öffnet http://localhost:3000. Ihre Dokumentation ist live.

Automatische Port-Umleitung

Wenn Port 3000 bereits verwendet wird, findet docmd automatisch den nächsten verfügbaren Port (z. B. 3001).

2. Automatische Funktionen

Die Engine richtet alles automatisch ein:

  1. Ordnererkennung - Sucht nach docs/, src/docs/, documentation/ oder .md-Dateien.
  2. Navigationserstellung - Erstellt eine verschachtelte Seitenleiste aus Ihrer Ordnerstruktur.
  3. Titel-Auflösung - Extrahiert automatisch Seitentitel aus dem ersten H1-Tag.
  4. Suchindexierung - Aktiviert sofort die integrierte Volltextsuche.
  5. Intelligentes Caching - Erzeugt beim Speichern sub-200ms-Neuerstellungen.

Es wird keine docmd.config.json benötigt. Fügen Sie später eine hinzu, um Layouts, Plugins oder Versionen anzupassen.

3. Für die Produktion erstellen

Kompilieren Sie Ihre Markdown-Dateien in eine statische, produktionsreife Website.

npm
Bun
npx @docmd/core build
bunx @docmd/core build

Der Compiler gibt eine statische Website in ./site/ aus.

Hosten Sie diese statische Ausgabe überall. Stellen Sie auf GitHub Pages, Vercel, Netlify oder einem anderen statischen Host bereit.