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

Entwicklungsserver starten

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

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

Was automatisch passiert

docmd scannt Ihr Projekt und richtet alles ein:

  1. Ordnererkennung — sucht nach docs/, src/docs/, documentation/ oder beliebigen .md-Dateien
  2. Navigationserstellung — erstellt eine verschachtelte Seitenleiste aus Ihrer Ordnerstruktur
  3. Metadaten-Extraktion — liest die package.json für den Seitentitel aus, falls verfügbar
  4. Theme-Aktivierung — wendet das Standard-Theme mit systemabhängigem Hell-/Dunkelmodus an
  5. Suchindexierung — ermöglicht die integrierte Volltextsuche

Es wird keine docmd.config.js benötigt. Fügen Sie später eine hinzu, wenn Sie Versionierung, Plugins oder eine benutzerdefinierte Navigation benötigen.

Für die Produktion erstellen

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

Gibt eine statische Website in ./site/ aus, die überall bereitgestellt werden kann.