Zum Hauptinhalt springen

Admonitions

Als Erweiterung der Standard-Markdown-Syntax werden sog. 👉 Admonitions, also Hinweise, die durch das Einrahmen von Text mit drei Doppelpunkten und einem Label, das den Typ angibt, erstellt werden.

:::note
Beliebiger **Inhalt** mit *Markdown* `Syntax`, inkl. __Erweiterungen__.
:::

:::tip
Beliebiger **Inhalt** mit *Markdown* `Syntax`, inkl. __Erweiterungen__.
:::

:::info
Beliebiger **Inhalt** mit *Markdown* `Syntax`, inkl. __Erweiterungen__.
:::

:::warning
Beliebiger **Inhalt** mit *Markdown* `Syntax`, inkl. __Erweiterungen__.
:::

:::danger
Beliebiger **Inhalt** mit *Markdown* `Syntax`, inkl. __Erweiterungen__.
:::
http://localhost:3000
hinweis

Beliebiger Inhalt mit Markdown Syntax, inkl. Erweiterungen.

tipp

Beliebiger Inhalt mit Markdown Syntax, inkl. Erweiterungen.

info

Beliebiger Inhalt mit Markdown Syntax, inkl. Erweiterungen.

warnung

Beliebiger Inhalt mit Markdown Syntax, inkl. Erweiterungen.

gefahr

Beliebiger Inhalt mit Markdown Syntax, inkl. Erweiterungen.

Titel anpassen

Der Titel der Admonition kann durch Hinzufügen von Text nach dem Admonition-Typ angepasst werden:

:::info[Anpassung des `Titels`]
Beliebiger **Inhalt** mit *Markdown* `Syntax`, inkl. __Erweiterungen__.
:::
http://localhost:3000
Anpassung des Titels

Beliebiger Inhalt mit Markdown Syntax, inkl. Erweiterungen.

Verschachtelte Admonitions

Admonitions basieren auf dem 👉 remark-directives. Der entsprechende Parser unterstützt Verschachtelungen wie folgt:

:::::warning[Wichtiger Hinweise]
Wichtige Hinweise zu beachten:
::::info[Erster Hinweis]
Dies ist der erste Hinweis.
:::tip[Bemerke]
Jede Verschachtelungsebene hat einen zusätzlichen Doppelpunkt `:`.
:::
::::
:::danger[Zweiter Hinweis]
Die Übersichtlichkeit leidet 😅🥸🫣.
:::
:::::
http://localhost:3000
Wichtiger Hinweise

Wichtige Hinweise zu beachten:

Erster Hinweis

Dies ist der erste Hinweis.

Bemerke

Jede Verschachtelungsebene hat einen zusätzlichen Doppelpunkt :.

Zweiter Hinweis

Die Übersichtlichkeit leidet 😅🥸🫣.

Admonitions in Listen

Um Admonitions in Listen zu verwenden, muss die Einrückung korrekt sein.

- Erster Punkt
:::info
Dies ist eine Admonition in einer Liste.
:::
- Zweiter Punkt
1. Mit Unterliste
2. und Admonition
:::tip
Dies ist eine Admonition in einer Unterliste.
:::
3. Weiter im Text
- Dritter Punkt
http://localhost:3000
  • Erster Punkt
    info

    Dies ist eine Admonition in einer Liste.

  • Zweiter Punkt
    1. Mit Unterliste
    2. und Admonition
      tipp

      Dies ist eine Admonition in einer Unterliste.

    3. Weiter im Text
  • Dritter Punkt

Weitere Admonition-Typen

Weitere Admonition-Typen

In den meisten Installationen von tdev sind die folgenden zusätzlichen Admonition-Typen ebenfalls verfügbar:

  • :::definition
  • :::finding
  • :::insight
  • :::aufgabe