Markdown Cheat Sheet
Eine durchsuchbare Übersicht der Markdown-Syntax. Markdown schreibe ich jeden Tag, in READMEs, Notizen und Portfolio-Texten wie diesem. Trotzdem schlage ich regelmäßig nach: Wie ging noch mal die Tabellenausrichtung, was rendert GitHub und was Obsidian? Deshalb steht jetzt alles auf einer Seite: markdown-syntax.html.
140 Einträge, aufgeteilt in 16 Gruppen, von Überschriften, Hervorhebungen und Listen über Links, Bilder, Code und Tabellen bis zu Fußnoten, Mathe, Mermaid und HTML in Markdown. Dazu kommen zwei Gruppen für Obsidian: Wikilinks, Embeds, Block-Referenzen, Callouts, Tags, Properties und Kommentare. Eine weitere Gruppe sammelt die Eigenheiten der Chat-Apps, denn Slack, Teams und WhatsApp setzen fett mit nur einem Sternchen, Discord kennt Spoiler und Untertitel. Die letzte deckt Dokumentations-Tools wie MkDocs, Docusaurus, VitePress, GitBook und Hugo ab, dazu GitLab und Azure DevOps: Hinweisboxen, Tabs, Inhaltsverzeichnisse. Jeder Eintrag zeigt links die Syntax, rechts was sie tut und, wo es hilft, gleich das Ergebnis. Die Markdown-Zeichen sind farbig abgesetzt, so sieht man auf einen Blick, was Auszeichnung ist und was Inhalt. Ein Klick auf die Syntax kopiert sie in die Zwischenablage.
Weil nicht jedes Markdown gleich ist, tragen Einträge außerhalb von CommonMark ein Kürzel: gfm für GitHub Flavored Markdown, gh für GitHub-Extras wie Alerts oder Emoji, obs für Obsidian, chat für Chat-Apps und Foren, docs für Dokumentations-Tools, ext für Erweiterungen, die je nach App funktionieren oder nicht, und html für eingebettetes HTML. Ein Klick auf ein Kürzel in der Legende blendet die zugehörigen Einträge aus und wieder ein. Wer für Obsidian schreibt, schaltet gh einfach ab. Wo GitHub und Obsidian sich unterscheiden, etwa beim Zeilenumbruch oder bei Markdown innerhalb von HTML, steht es direkt am Eintrag.
Das Suchfeld filtert beim Tippen. Man kann nach dem Namen suchen („table“, „callout“) oder nach der Syntax selbst: Wer [[ eintippt, landet direkt bei den Wikilinks. Gruppen ohne Treffer blenden sich aus.
Gesetzt ist die Seite wie das OneCommander Cheat Sheet in Geist Mono, die gerenderten Beispiele in Geist, beide über Google Fonts. So unterscheidet sich Quelltext auch typografisch vom Ergebnis. Die Seite folgt dem Hell- oder Dunkelmodus des Systems, lässt sich per Schalter oben rechts aber auch umstellen und merkt sich die Wahl. Sie funktioniert auch auf dem Smartphone.
Technisch ist es eine einzige HTML-Datei ohne Abhängigkeiten außer den Schriften. Die Einträge stehen als Datenliste im Script, die Tabellen werden daraus beim Laden gebaut. Quellen sind die CommonMark-Spezifikation 0.31.2, die GFM-Spezifikation, die GitHub-Dokumentation, der Markdown Guide, die Obsidian-Hilfe und die offiziellen Dokumentationen der jeweiligen Chat-Apps und Tools. Lizenz: GNU 3.0. Auch in meinem GitHub zu finden.
