docmd verfügt über eine intelligente Heuristik-Engine, die Ihre Dokumentation automatisch parst und strukturiert. Sie können mit dem Erstellen, Bereitstellen und Übersetzen Ihrer Dokumentation beginnen, ohne eine einzige Zeile Konfiguration zu schreiben.

Funktionsweise

Wird docmd ohne docmd.config.json-Datei ausgeführt, wechselt die Engine automatisch in den Zero-Config-Modus. Sie durchsucht das Workspace-Verzeichnis nach Inhalten und wendet die folgenden Heuristiken an:

1. Quellverzeichniserkennung

Die Engine sucht in dieser Reihenfolge nach Dokumentationsdateien in den folgenden Kandidatenverzeichnissen:

1. docs/
2. src/docs/
3. documentation/
4. content/
5. . (Root-Verzeichnis-Fallback)

Wird eines der Kandidatenverzeichnisse gefunden und enthält es Markdown-Dateien, wird es als Quelle gewählt. Wird kein Verzeichnis gefunden, der Projektstamm enthält jedoch Markdown-Dateien, wird der Root verwendet (automatisch ausgeschlossen werden node_modules, .git sowie Ausgabeordner wie site/, dist/ und out/).

Wird überhaupt kein Dokumentationsinhalt gefunden, initialisiert docmd automatisch eine neue Starter-Struktur.

2. Heuristiken für Versionen und Sprachen

Die Ordnerstruktur wird gescannt, um Versions- und Lokalisierungsmetadaten dynamisch zu extrahieren:

• Versionen: Unterverzeichnisse, die v[0-9]+ entsprechen (z. B. v1.0, v08), werden als Dokumentationsversionen geparst.
• Sprachen: Unterverzeichnisse mit zweistelligen Sprachcodes (z. B. en, de, zh) werden als lokalisierte Varianten behandelt.
• Strukturextraktion: Die höchste Version wird als aktuelle Veröffentlichung festgelegt, und die zuerst gefundene Sprache (mit Priorität auf en) wird als Standardsprache gesetzt.

3. Automatisches Navigations-Routing

Existieren keine Root-Versionen oder Sprachen, baut die Engine die Navigationsstruktur dynamisch aus der Dateistruktur auf:

• Unterverzeichnisse werden auf Navigationsgruppen abgebildet.
• Titel werden dynamisch aus den Datei-Basenamen erzeugt. Z. B. wird getting-started.md zu Getting Started formatiert.
• Indexdateien (index.md, README.md) werden als Landingpage des aktuellen Verzeichnisses geroutet.

Zero-Config-Best Practices

Um das Beste aus dem Zero-Config-Modus herauszuholen, befolgen Sie diese Struktur-Empfehlungen:

• Explizite Dateibenennung: Verwenden Sie klare, mit Bindestrichen versehene oder camelCase-Dateinamen. Der Autoloader konvertiert sie in lesbare Titel.
• Ordnerbasierte Sektionen: Platzieren Sie zusammengehörige Dokumente in Unterordnern, um sie in der Sidebar automatisch zu gruppieren.
• Index-Fallback: Legen Sie immer eine index.md oder README.md im Stamm Ihres Quellverzeichnisses ab, die als Landingpage dient.
• Sauberer Ausgabepfad: Falls Sie den Root-Ordner . als Quelle verwenden, belassen Sie Ihre Build-Artefakte im Standard-Ordner site/, der automatisch ignoriert wird.

Eingebaute Standardwerte (neu in 0.8.7)

Eine docmd.config.json (oder gar keine Konfiguration) liefert eine sofort nutzbare Site. Die folgenden Schlüssel werden mit sinnvollen Standards ausgeliefert, sodass Sie sie nur setzen müssen, wenn Sie einen anderen Wert wünschen.

QoL-Standards auf oberster Ebene

Layout- und Sidebar-Standards

Footer-Standards

Theme-Standards

Neue Opt-in-Funktionen (standardmäßig aus)

Die Standards wurden so gewählt, dass brandneue Sites ohne Konfiguration ein nutzbares Erscheinungsbild erhalten. Ältere Konfigurationen behalten ihre expliziten Werte — nur undefined-Schlüssel werden aufgefüllt.