Markdown Spickzettel

Kurzreferenz für Markdown-Syntax — Überschriften, Listen, Links, Codeblöcke, Tabellen und mehr, mit Live-Rendervorschau.

Markdown
Vorschau

Anleitung

  1. Navigiere über das Inhaltsverzeichnis links zu einer beliebigen Syntaxkategorie.
  2. Jede Karte zeigt links die rohe Markdown-Syntax und rechts das gerenderte Ergebnis.
  3. Klicke auf den Kopieren-Button, um den Markdown-Schnipsel in die Zwischenablage zu kopieren.
  4. Nutze diese Schnipsel direkt in GitHub, Notion, VS Code, Obsidian oder jedem anderen Markdown-Editor.

Häufig gestellte Fragen

  • Was ist Markdown?

    Markdown ist eine leichtgewichtige Auszeichnungssprache, die 2004 von John Gruber entwickelt wurde. Sie ermöglicht das Schreiben von formatiertem Text mit einfachen Textsymbolen — z.B. macht das Umschließen von Text mit ** ihn fett. Markdown-Dateien werden von Renderern in GitHub, Blog-Plattformen, Dokumentationstools und Notiz-Apps in HTML umgewandelt.

  • Ist Markdown überall gleich?

    Die Basissyntax ist weitgehend konsistent, aber verschiedene Plattformen unterstützen unterschiedliche Erweiterungen. GitHub Flavored Markdown (GFM) fügt Aufgabenlisten, Durchstreichungen und Tabellen hinzu. Obsidian unterstützt Wikilinks. Manche Plattformen verwenden CommonMark als Standard. Dieser Spickzettel konzentriert sich auf die am weitesten unterstützten Funktionen.

  • Wie mache ich einen Zeilenumbruch in Markdown?

    Beende eine Zeile mit zwei Leerzeichen und drücke Enter, um einen weichen Zeilenumbruch zu erzeugen. Für einen Absatzumbruch lass eine Leerzeile zwischen zwei Zeilen. In vielen Renderern wird ein einfacher Zeilenumbruch ohne abschließende Leerzeichen als Leerzeichen behandelt, nicht als Umbruch.

  • Kann ich HTML in Markdown verwenden?

    Die meisten Markdown-Renderer erlauben inline HTML. Du kannst z.B. <br> für Zeilenumbrüche, <u>Text</u> für Unterstreichungen oder <details> für aufklappbare Abschnitte verwenden. Die Unterstützung variiert jedoch — sicherheitsorientierte Renderer entfernen HTML vollständig.

Was ist Markdown?

Markdown ist eine Klartextsyntax, die in HTML umgewandelt wird. Erstellt von John Gruber im Jahr 2004, wurde es so entwickelt, dass der Rohtext auch ohne Rendering wie formatierten Text aussieht. Heute wird es überall verwendet: GitHub READMEs, technische Dokumentation, Blog-Plattformen, Notiz-Apps wie Obsidian und Notion sowie Chat-Tools wie Slack und Discord.

Die Kernidee ist einfach: gewöhnliche Zeichen zur Formatierungsangabe verwenden. Ein # vor einer Zeile macht sie zur Überschrift. Text mit ** umschließen macht ihn fett. Eine Zeile mit vier Leerzeichen einrücken macht sie zu einem Codeblock.

Wie ein Markdown-Spickzettel hilft

Selbst erfahrene Autoren vergessen gelegentlich die genaue Syntax für Tabellenausrichtung, verschachtelte Listen oder Codeblöcke mit Syntaxhervorhebung. Ein Spickzettel dient als schnelles Nachschlagewerk — du siehst die Rohsyntax und das gerenderte Ergebnis nebeneinander.

Dieser Spickzettel behandelt:

  • Überschriften — vier Ebenen von h1 bis h4
  • Textformatierung — fett, kursiv, Durchstreichung, Inline-Code, Hyperlinks
  • Listen — geordnet, ungeordnet, verschachtelt und Aufgabenlisten
  • Links und Bilder — Inline-Links, Links mit Titel, Bilder
  • Blockzitate — einfach und verschachtelt
  • Codeblöcke — eingegrenzt mit optionaler Sprache für Syntaxhervorhebung
  • Tabellen — mit Spaltenausrichtungsoptionen
  • Horizontale Linien — als visuelle Trennelemente

Markdown-Dialekte

CommonMark ist eine standardisierte Spezifikation, die Mehrdeutigkeiten in der ursprünglichen Spezifikation behebt. GitHub, GitLab, Discourse und viele andere Plattformen folgen CommonMark oder etwas Ähnlichem.

GitHub Flavored Markdown (GFM) fügt Aufgabenlisten (- [x]), Durchstreichungen (~~Text~~), Tabellen und automatische Links hinzu. Die meisten Code-Plattformen unterstützen GFM oder eine Obermenge davon.

Für alltägliches technisches Schreiben — READMEs, Dokumentation, Blog-Beiträge, Notizen — deckt Standard-CommonMark plus GFM-Erweiterungen praktisch alles ab, was du brauchst.

Tipps für gutes Markdown schreiben

Konsistent bei Listenmarkierungen bleiben. Wähle - oder * für ungeordnete Listen und behalte diese Wahl bei. Mischen ist gültig, macht den Rohtext aber schwerer lesbar.

Leerzeilen zwischen Blockelementen verwenden. Eine Leerzeile vor und nach Überschriften, Codeblöcken und Blockzitaten stellt die korrekte Darstellung in verschiedenen Parsern sicher.

Eingegrenzte Codeblöcke bevorzugen. Blöcke mit dreifachen Backticks ermöglichen die Angabe der Sprache für Syntaxhervorhebung und sind im Quelltext optisch klarer.

Beschreibenden Link-Text verwenden. [Hier klicken](url) ist schlechter als [Markdown-Spezifikation](url) sowohl für Lesbarkeit als auch Barrierefreiheit.