Zum Inhalt springen
tbsch Theme
Funktionen

Admonitions - Hinweisboxen

Hinweisboxen entstehen aus GitHub-Style-Alerts in ganz normalem Markdown: ein Blockzitat, dessen erste Zeile [!typ] enthält. Der Blockquote-Render-Hook macht daraus eine farbige Box mit Icon und Titel.

Die Typen #

> [!note]
> So schreibst du eine Hinweisbox.
Hinweis

Ein neutraler Hinweis. note ist der Standardtyp.

Info

Eine Information - wie note, nur in Blau.

Tipp

Ein hilfreicher Tipp (tip).

Erfolg

Hat geklappt! success ist für erledigte Dinge und Erfolge.

Wichtig

Etwas Wichtiges (important), das man nicht überlesen sollte.

Warnung

Eine Warnung (warning) - hier ist Vorsicht geboten.

Vorsicht

caution - noch eine Stufe ernster.

Achtung

Achtung, hier kann etwas kaputtgehen - danger.

Fehler

Etwas ist fehlgeschlagen (failure).

Frage

Eine offene Frage oder ein FAQ-Eintrag - question.

Eigener Titel #

Schreib den Titel hinter den Typ:

> [!tip] Mein eigener Titel
> Inhalt der Box.
Mein eigener Titel

Der Standardtitel (“Tipp”) wird durch deinen Text ersetzt.

Aufklappbar #

Ein + macht die Box zu einem aufgeklappten <details>, ein - zu einem zugeklappten:

> [!info]- Zugeklappt - zum Aufklappen tippen
> Dieser Inhalt ist anfangs verborgen.
Zugeklappt - zum Aufklappen tippen

Dieser Inhalt ist anfangs verborgen und klappt auf Klick aus.

Aufgeklappt - kann zugeklappt werden

Diese Box ist offen, lässt sich aber zuklappen.

Aliase #

Viele gebräuchliche Schreibweisen werden automatisch übersetzt, z. B. [!warning]/[!attention], [!tip]/[!hint], [!danger]/[!error], [!success]/[!check]/[!done] oder [!question]/[!faq].

Tipp

hint ist ein Alias für tip.

Es gibt außerdem einen Typ affiliate für Werbehinweise - der wird vom Theme auch automatisch oben in Beiträgen mit Affiliate-Links eingeblendet.

Mitgeredet

Reaktionen

Noch keine Reaktionen - sei die/der Erste.

Weiterlesen

Verwandte Beiträge