Eine Standard-docmd-Seite besteht aus sechs zentralen funktionalen UI-Zonen:
- Menubar: Vollbreite obere Navigationsleiste für globale projektübergreifende Links.
- Header: Persistenter sekundärer Header, der Seitentitel, Brotkrumen und das Optionsmenü anzeigt.
- Sidebar: Primärer Navigationsbaum für die Inhaltsstruktur der Website.
- Inhaltsbereich (Content Area): Zentraler Markdown-Rendering-Container mit automatisierten Brotkrumen.
- Inhaltsverzeichnis (TOC): Rechtsseitige Überschriften-Navigation für aktive Artikel.
- Footer: Unterer Bereich zur Anzeige von Copyright-Hinweisen, Branding-Attributierung und Footer-Link-Spalten.
Komponenten-Layoutoptionen
Konfigurieren Sie Schnittstellenzonen im layout-Abschnitt Ihres docmd.config.json-Manifests.
Die Menubar-Zone
Die Menubar bietet eine globale Website-Navigation und unterstützt Logos, Links und verschachtelte Dropdown-Menüs:
- Platzierung: Fixiert am absoluten Viewport-
topoder innerhalb desheaderpositioniert. - Dokumentation: Siehe Menubar-Konfiguration für vollständige Eigenschaften und Anpassungsoptionen.
Die Seiten-Header-Zone
Der Header zeigt aktive Seitentitel, Brotkrumen und Optionsmenüs an:
- Globaler Umschalter: Aktivieren oder deaktivieren Sie den Header global über
layout.header.enabled. Schalten Sie Brotkrumen überlayout.breadcrumbsum. - Überschreibung pro Seite: Fügen Sie
hideTitle: truezum Frontmatter eines Dokuments hinzu, um dessen Header-Titel lokal auszublenden.
Kontextuelle Kopier-Widgets
Der Header-Bereich enthält kontextuelle Kopierwerkzeuge: Ein-Klick-Kopieren des rohen Markdown-Quellcodes und strukturierter KI-Kontext-Prompts (enthält Seiten-URL, Titel, Beschreibung und Fließtext):
{
"theme": {
"copyWidgets": {
"enabled": true,
"raw": true,
"context": true
}
}
}
enabled: Auffalsesetzen, um die Kopier-Widget-Leiste vollständig zu deaktivieren.raw: Auffalsesetzen, um die Schaltfläche „Markdown kopieren" auszublenden.context: Auffalsesetzen, um die Schaltfläche „Kontext kopieren" auszublenden.
Optionsmenü (Dienstprogramme)
Das optionsMenu gruppiert globale Dienstprogramme wie Suche, Theme-Modus-Umschalter und Sponsoring-Links:
{
"layout": {
"optionsMenu": {
"position": "header",
"components": {
"search": true,
"themeSwitch": true,
"sponsor": "https://github.com/sponsors/mgks"
}
}
}
}
Wenn optionsMenu einem Container zugewiesen ist, der deaktiviert ist, verschiebt der Kompiler das Optionsmenü automatisch nach sidebar-top, um die Barrierefreiheit zu gewährleisten.
Sidebar & Navigation
Die Sidebar dient als primäre Navigationshierarchie:
- Verhalten: Unterstützt Desktop-Einklappen, sanfte Zustandsübergänge und verfolgechtes Routing.
- Dokumentation: Siehe Navigationskonfiguration.
Footer-Bereich
docmd bietet minimal- und complete-Footer-Layouts:
{
"layout": {
"footer": {
"style": "complete",
"description": "Dokumentation erstellt mit docmd.",
"branding": true,
"columns": [
{
"title": "Community",
"links": [
{ "text": "GitHub", "url": "https://github.com/docmd-io/docmd" }
]
}
]
}
}
}
Reservieren Sie die obere Menubar für domänenübergreifende Navigation und verwenden Sie die Sidebar für eine tiefe Dokumentationsstruktur. Eine klare Trennung hält die Navigation sowohl für Benutzer als auch für Web-Crawler intuitiv.