Eine Standardseite enthält sechs primäre Funktionszonen:
- Menubar: Eine vollbreite obere Navigationsleiste für globale Site-Links.
- Header: Eine persistente sekundäre Leiste. Enthält den Seitentitel und Utility-Schaltflächen.
- Sidebar: Der primäre Navigationsbaum, meist auf der linken Seite.
- Content Area: Der zentrale Markdown-Renderbereich. Enthält Brotkrumen.
- Table of Contents (TOC): Rechtsseitige Überschriften-Navigation der aktuellen Seite.
- Footer: Unterer Bereich für Copyright, Branding und Site-weite Links.
Globale Komponentenkonfiguration
Die Engine verwendet ein modulares Layout-System. Konfigurieren Sie die meisten UI-Zonen im layout-Abschnitt Ihrer docmd.config.json.
Menubar
Die Menubar stellt eine hochrangige Navigationsebene bereit. Sie unterstützt Markentitel, reguläre Links und verschachtelte Dropdowns.
- Position: Fest fixiert am
topoder inline innerhalb desheader. - Dokumentation: Schemas und Styling finden Sie unter Menubar-Konfiguration.
Der Seiten-Header
Der Header zeigt den Seitentitel, Brotkrumen und Utility-Menüs.
- Steuerung: Aktivieren oder deaktivieren Sie den Header global über
layout.header. Schalten Sie Brotkrumen überlayout.breadcrumbsum. - Überschreiben: Verwenden Sie
hideTitle: truein Ihrem Seiten-Frontmatter, um den Titelbereich lokal auszublenden.
Copy-Widgets
Die Brotkrumen-Leiste enthält zwei Kopierschaltflächen. Eine kopiert das rohe Markdown der Seite, die andere einen strukturierten Kontextblock, der URL, Titel und Beschreibung enthält. Nützlich zum Einfügen in KI-Chatfenster oder Support-Tickets.
Konfigurieren Sie diese Schaltflächen unter theme.copyWidgets in Ihrer docmd.config.json:
{
"theme": {
"copyWidgets": {
"enabled": true,
"raw": true,
"context": true
}
}
}
enabled: Auffalsesetzen, um die Leiste vollständig zu deaktivieren.raw: Auffalsesetzen, um die Schaltfläche „Markdown kopieren" auszublenden.context: Auffalsesetzen, um die Schaltfläche „Kontext kopieren" auszublenden.
Utility-Menüs (Optionsmenü)
Das optionsMenu gruppiert zentrale Utilities wie Globale Suche, Theme-Umschalter und Sponsoring-Links.
{
"layout": {
"optionsMenu": {
"position": "header",
"components": {
"search": true,
"themeSwitch": true,
"sponsor": "https://github.com/sponsors/mgks"
}
}
}
}
Wenn die gewählte Position auf einen deaktivierten Container verweist, verschiebt die Engine das Optionsmenü auf sidebar-top. So bleiben die Utilities stets erreichbar.
Sidebar & Navigation
Die Sidebar ist der primäre Navigationsbaum. Definieren Sie ihre Struktur in Ihrer Konfiguration oder in externen JSON-Dateien.
- Verhalten: Unterstützt Animationen, einklappbare Gruppen und automatische Pfad-Erhaltung.
- Dokumentation: Siehe Navigationskonfiguration.
Footer
Die Engine bietet minimal- und complete-Layouts für Ihren Site-Footer.
{
"layout": {
"footer": {
"style": "complete",
"description": "Documentation built with docmd.",
"branding": true,
"columns": [
{
"title": "Community",
"links": [
{ "text": "GitHub", "url": "https://github.com/docmd-io/docmd" }
]
}
]
}
}
}
Verwenden Sie die Menubar für globale Links und die Sidebar für die Dokumentationsstruktur. Diese Trennung hält die Navigation sowohl für menschliche Leser als auch für Crawler vorhersagbar.