Worknote: MkDocs und die Admonition Extension

Wer sich öfter auf den ReadTheDocs-Seiten herumgetrieben hat, dem sind sicher die bunt hinterlegten Memos aufgefallen. Ich hatte bisher gedacht, daß sie ein ReST-only Feature und in Markdown nicht nachzubilden sind. Aber ich hatte meine Rechnung ohne die Python Markdown Extensions gemacht. Diese – genauer die Admonition Extension – bilden dieses bunten Memos nämlich auch in Markdown nach.

Um das auch in MkDocs, also zum Beispiel auch in meinem statischen Evernote-Nachbau Nevernote, zu nutzen, muß man die Extension als erstes in der mkdocs.yml die Extension dem Programm bekanntmachen. Bei mir sieht das daher nun wie folgt aus:

markdown_extensions:
- footnotes
- admonition

- smarty:
    smart_quotes: False
- pymdownx.tasklist

Dann steht einem die Admonition-Extension zur Verfügung. In das Markdown-Dokument fügt man sie dann so ein (Beispiel):

!!! tip "Admonition Extension"
    Mit der [Admonition Extension](https://pythonhosted.org/Markdown/extensions/admonition.html) bekommt man hübsche Memos in MkDocs gezaubert.

!!! danger "Don't try this at home"
    Das solltest Du nie zu Hause ausprobieren!

!!! warning "Warnung!"
    Achte auf die Killer-Kaninchen!

!!! note "Eine schnelle Notiz"
    Blau geht auch …

Außer den vier genannten gibt es noch mehr Typen, aber da es per Default nur vier Farben gibt, habe ich mich erst einmal auf die vier beschränkt (es steht Euch natürlich frei, via CSS andere Typen mit anderen Farben auszustatten – Ihr könnt sogar eigene Typen definieren.) Aber das wird dann schnell sehr unübersichtlich. Ich kann mir gerade noch merken:

• tip ist grün
• danger ist rot
• warning ist gelb (oder orange?) und
• note ist blau

Wenn Ihr dieses Feature nutzt, solltet Ihr auf jeden Fall bedenken, daß es PyMarkdown exklusiv ist. Also nutzt es nicht, wenn Ihr Euer Markdown-Dokument dann irgendwann doch noch durch einen anderen Markdown-Interpreter jagen wollt.

(Kommentieren)