Standard-Markdown eignet sich hervorragend für die grundlegende Textformatierung, aber eine professionelle technische Dokumentation erfordert reichhaltige strukturelle Komponenten, um komplexe Logik effektiv zu vermitteln. docmd erweitert Markdown um eine Reihe von isomorphen Containern, die in responsive, hochpräzise UI-Elemente gerendert werden.
docmd unterstützt Syntax-Aliase von VitePress und Docusaurus direkt. Container wie :::tip, :::warning, :::note, :::details und :::caution funktionieren ohne Änderung. Die leerzeichenlose Syntax (z. B. :::tabs statt ::: tabs) wird ebenfalls für alle Container unterstützt.
Block-Syntax-Referenz
Alle Container nutzen eine konsistente Block-Syntax, die eine vorhersehbare Bearbeitungserfahrung im gesamten Projekt gewährleistet.
::: typ "Optionaler Titel für die Kopfzeile"
Dies ist der primäre Inhaltsbereich.
Er unterstützt **Markdown**, Bilder und tiefe Verschachtelung von Komponenten.
:::
| Komponente | Schlüsselwort | Primärer Anwendungsfall |
|---|---|---|
| Callouts | callout |
Semantische Hervorhebungen für Tipps, Warnungen und Alarme. |
| Cards | card |
Gerahmte strukturelle Blöcke für Feature-Grids und Layout-Steuerung. |
| Grids | grids |
Sich automatisch anpassende, mehrspaltige Strukturgruppen. |
| Tabs | tabs |
Interaktive, umschaltbare Fenster für alternative Anweisungen. |
| Steps | steps |
Visuelle, nummerierte Zeitachsen für “How-to”-Anleitungen und Tutorials. |
| Collapsibles | collapsible |
Interaktive Akkordeon-Umschalter für FAQs und vertiefende technische Daten. |
| Buttons | button |
Selbstschließende, prominente Call-to-Action-Navigationslinks. |
| Tags | tag |
Selbstschließende, farbige Labels für Versionen, Status oder Hervorhebungen. |
| Hero | hero |
Wirkungsvolle Landingpage-Abschnitte mit Layout- und Slider-Unterstützung. |
| URL-Einbettungen | embed |
Sichere Einbettungen mit minimaler Ladezeit für Videos, Social Media und interaktive Inhalte. |
| Changelogs | changelog |
Strukturierte, zeitachsenbasierte Versionshistorie und Versionshinweise. |
| Verschachtelte Container | - | Rekursive Kompositionsmuster für komplexe Layouts aus mehreren Komponenten. |
Die strategische Bedeutung von Containern
Container bieten mehr als nur optischen Glanz; sie liefern hochpräzise semantische Signale an die docmd-Engine und nachgeschaltete KI-Agenten:
- KI-Kontext-Mapping: Das Markieren eines Blocks als
callout warningsignalisiert LLMs explizit, diese Informationen während der Denk- und Generierungsphasen zu priorisieren. - Strukturelle Integrität: Die Kombination von
cardsmit Standard-CSS ermöglicht die Erstellung anspruchsvoller Landingpages, ohne die Markdown-Umgebung zu verlassen. - Wartbarkeit des Quellcodes: Eliminiert “HTML-Aufblähung” in Ihrem Dokumentationsquellcode und hält Ihre
.md-Dateien sauber und maschinenlesbar.
Rekursive Komposition
docmd unterstützt unendliche Verschachtelungstiefe. Sie können jeden Container in einem anderen kombinieren, um komplexe, interaktive Dokumentationsknoten rein in Markdown zu erstellen.
::: card "Architektur-Übersicht"
::: callout info
Dieses Modul nutzt eine asynchrone I/O-Pipeline.
:::
::: button "Tiefes Eintauchen in den Core" /advanced/developer-guide
:::