Der tag-Container ist eine selbstschließende Komponente, die kleine, pillenförmige Badges inline einfügt. Tags behalten überall ihre kompakten Proportionen — sie übernehmen keine Überschriftengrößen oder umgebenden Textstile.
Container-Syntax
::: tag [title:"Badge-Text"] [color:css_farbe|hex_code] [icon:icon_name] [url:[external:]adresse]
Funktionen & Unterstützte Attribute
| Parameter / Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Badge-Beschriftung | "String" | title:"..." |
Text im pillenförmigen Badge (1. Parameter oder title:"..."). |
| Hintergrundfarbe | color:VALUE |
Wendet Hintergrundfarbe an (CSS-Namen oder Hex). Textkontrast wird berechnet. |
| Iconografie | icon:NAME |
Fügt ein Lucide-Icon im Badge hinzu. |
| Hyperlink-URL | url:URL |
Wandelt Tag in einen Link um. Präfix external: öffnet neuen Tab. |
Ab v0.9.1 führt docmd explizite Öffnungs- und Schließungs-Container-Tags (z.B. ::: card … ::: /card, ::: tab … ::: /tab), explizite Key-Value-Eigenschaften (title:"...", url:"...") und nachfolgende # Kommentare ein. Diese modernisierte Syntax wird für alle neuen Dokumentationen empfohlen. Die vollständige Abwärtskompatibilität für alte Sub-Block-Marker (== tab, 1.) und Positionsparameter bleibt strikt erhalten.
Beispiele
Versions-Badge
Verwenden Sie einen farbigen Tag inline, um zu kennzeichnen, wann ein Feature eingeführt wurde.
This feature was added in ::: tag "v0.8.2" color:blue and works perfectly.
This feature was added in v0.8.2
Status-Labels
Verwenden Sie Tags für Statusindikatoren über eine Seite hinweg. Farben sind vollständig anpassbar.
::: tag title:"Deprecated" color:#ef4444
::: tag title:"Beta" color:#eab308
::: tag title:"Stable" color:#22c55e
::: tag title:"Verified" icon:check-circle color:#10b981
Beta
Stable
Verified
Verlinkter Tag
Fügen Sie url: hinzu, damit ein Tag als Hyperlink fungiert — nützlich für Querverweise auf Release Notes oder externe Ressourcen. Der Wert steht ohne Anführungszeichen, passend zur Konvention der Buttons.
Check out the latest ::: tag "Release Notes" icon:external-link url:/de/release-notes/0-8-2.md
Check out the latest Release Notes
Externer Link
Mit dem Präfix external: vor der URL öffnet der Link in einem neuen Tab, auch wenn das Ziel in Ihrer eigenen Domain liegt.
::: tag title:"GitHub" icon:github url:external:https://github.com/docmd-io/docmd