Standard-Markdown glänzt bei der grundlegenden Textformatierung, aber professionelle technische Dokumentationen erfordern reichhaltige strukturelle Komponenten, um komplexe Logik effektiv zu vermitteln. docmd erweitert Markdown um eine Reihe von isomorphen Containern, die in responsive, hochwertige UI-Elemente gerendert werden.
Referenz für die Block-Syntax
Alle Container verwenden eine konsistente Block-Syntax, was eine vorhersehbare Authoring-Erfahrung über Ihr gesamtes Projekt hinweg gewährleistet.
::: typ "Optionaler Titel"
Dies ist der Hauptinhaltsbereich.
Er unterstützt **Markdown**, Bilder und tiefe Verschachtelungen von Komponenten.
:::
| Komponente | Schlüsselwort | Primärer Anwendungsfall |
|---|---|---|
| Callouts | callout |
Semantische Hervorhebungen für Tipps, Warnungen und Alarme. |
| Karten | card |
Eingerahmte Strukturblöcke für Feature-Raster und Layoutsteuerung. |
| Raster | grids |
Automatisch anpassbare, mehrspaltige Strukturgruppen. |
| Tabs | tabs |
Interaktive, umschaltbare Bereiche für plattformspezifische Anweisungen. |
| Schritte | steps |
Visuelle, nummerierte Zeitachsen für Anleitungen (“How-to”) und Tutorials. |
| Buttons | button |
Selbstschließende, prominente Call-to-Action-Navigationslinks. |
| Ausklappbar | collapsible |
Interaktive Akkordeon-Umschalter für FAQs und technische Vertiefungen. |
| Changelogs | changelog |
Strukturierte, zeitachsenbasierte Versionshistorie und Release-Notes. |
| Hero | hero |
Eindrucksvolle Landingpage-Abschnitte mit Layout- und Slider-Unterstützung. |
Die strategische Bedeutung von Containern
Container ermöglichen mehr als nur visuelles Design; sie liefern hochwertige semantische Signale an die docmd-Engine und nachgelagerte KI-Agenten:
- KI-Kontext-Mapping: Die Kennzeichnung eines Blocks als
callout warningteilt LLMs explizit mit, diese Information während der Argumentations- und Generierungsphase zu priorisieren. - Strukturelle Integrität: Die Kombination von
cardsmit Standard-CSS ermöglicht die Erstellung anspruchsvoller Landingpages, ohne die Markdown-Umgebung verlassen zu müssen. - Wartbarkeit der Quelle: Eliminiert „HTML-Aufblähung“ in Ihrer Dokumentationsquelle und hält Ihre
.md-Dateien sauber und maschinenlesbar.
Rekursive Komposition (Verschachtelung)
docmd unterstützt unbegrenzte Verschachtelungstiefe. Sie können jeden Container innerhalb eines 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 "Tauchgang in die Core-Engine" /advanced/developer-guide
:::