Projektstruktur
docmd verwendet Ihr Dateisystem als Quelle der Wahrheit. Ordner werden zu Abschnitten, Markdown-Dateien zu Seiten und die Verzeichnishierarchie definiert die URL-Routen.
Ein Projekt initialisieren
npm
Bun
mkdir meine-dokumentation && cd meine-dokumentation
npx @docmd/core init
mkdir meine-dokumentation && cd meine-dokumentation
bunx @docmd/core init
Dies erstellt das Standard-Projektgerüst:
meine-dokumentation/
├── docs/ ← Quellverzeichnis. Ihre .md-Dateien kommen hierher.
│ └── index.md ← Startseite (/)
├── assets/ ← Statische Assets (Bilder, eigenes CSS/JS)
│ ├── css/
│ ├── js/
│ └── images/
├── docmd.config.js ← Konfigurationsdatei
├── package.json ← Projektmetadaten und Skripte
└── site/ ← Generierte Ausgabe (nach dem Build)
Datei-zu-URL-Mapping
docmd bildet Ihre docs/-Verzeichnisstruktur direkt auf URLs ab:
| Datei | URL |
|---|---|
docs/index.md |
/ |
docs/api.md |
/api |
docs/guides/setup.md |
/guides/setup |
Automatische Titel
Wenn ein Seitentitel nicht im Frontmatter definiert ist, extrahiert docmd die erste H1-Überschrift als Titel.
Entwicklungsserver starten
npm
Bun
npx @docmd/core dev
bunx @docmd/core dev
Öffnet http://localhost:3000 mit Live-Reload. Änderungen an .md-Dateien oder der docmd.config.js werden sofort übernommen.
Für die Produktion erstellen
npm
Bun
npx @docmd/core build
bunx @docmd/core build
Gibt eine statische Website in ./site/ aus. Die Ausgabe besteht ausschließlich aus statischem HTML — stellen Sie sie auf GitHub Pages, Vercel, Netlify oder einem beliebigen statischen Host bereit.
Vor der Bereitstellung lokal überprüfen:
npm
Bun
npx serve site
bunx serve site