Tiefenblick

Markdown-Cheatsheet: Ein schneller, praktischer Leitfaden

koboshiCo-founder
·6 min Lesezeit
Markdown-Cheatsheet: Ein schneller, praktischer Leitfaden
Zusammenfassung

Markdown sieht einfach aus, bis man eine Tabelle, eine Fußnote oder einen Durchstreichung braucht, der überall gleich gerendert wird. Dieser Beitrag deckt die Kernsyntax, die wichtigsten Standards, praktische Beispiele, fortgeschrittene Tricks und eine ausdruckbare Cheatsheet ab. Außerdem verlinkt er auf die browserbasierten Markdown-to-PDF- und PDF-to-Markdown-Converter, wenn Formate gewechselt werden müssen.

Die meisten Dokumente beginnen als einfache Textdatei mit ein paar Sternen und Hash-Zeichen. Diese Datei ist meistens Markdown. Es ist nicht die einzige Art, fürs Web zu schreiben, aber der Standard für READMEs, Issue-Tracker, Chatbots und statische Websites, weil der Quelltext bereits vor der Renderung lesbar ist.

Dieser Beitrag ist ein schneller, praktischer Leitfaden. Er geht davon aus, dass du zehn Minuten und einen Texteditor hast. Keine Installation nötig.

Was Markdown ist

Markdown ist eine leichte Auszeichnungssyntax. John Gruber veröffentlichte 2004 die ursprüngliche Spezifikation mit einem Ziel: ein Format, das im Klartext gut aussieht und sauber in HTML umgewandelt wird. Seither ist es zum Eingabeformat für GitHub, Obsidian, Notion, viele statische Website-Generatoren und die meisten Outputs großer Sprachmodelle geworden.

Die Kernidee ist einfach. Struktur wird mit Satzzeichen statt Tags markiert:

# Das ist eine Überschrift

Das ist ein Absatz.

- Das ist ein Listenpunkt
- Das ist ein weiterer

Ein Parser wandelt das in HTML um. Verschiedene Parser unterstützen unterschiedliche Erweiterungen. Deshalb spielen Standards eine Rolle.

Markdown-Standards sind wichtig

Markdown hat keinen einzigen offiziellen Standard. Grubers ursprüngliche Spezifikation lässt Lücken, die verschiedene Tools auf inkompatible Weise gefüllt haben. Wenn man eine Tabelle in einer App schreibt und in eine andere einfügt, kann sie zerstört werden. Man sollte wissen, welchen Dialekt man anspricht.

  • CommonMark. Eine strenge, gut getestete Spezifikation, die 2014 begann. Sie definiert die Kernsyntax präzise. Wer Portabilität will, schreibt CommonMark.
  • GitHub Flavored Markdown (GFM). Ergänzt Tabellen, Aufgabenlisten, Durchstreichungen, eingezäunte Code-Blöcke und Autolinks. Das ist das Format von GitHub-READMEs und Issue-Kommentaren.
  • Pandoc Markdown. Fügt Zitate, Fußnoten, Definitionslisten, Hoch- und Tiefstellungen sowie Mathematik hinzu. Häufig in akademischem Schreiben.
  • Obsidian / Quarto / MDX. Diese ergänzen Wiki-Links, Callouts, ausführbare Code-Zellen oder eingebettete Komponenten. Leistungsstark, aber nicht portabel.

Für die tägliche Arbeit ist GFM am sichersten. Für längere Dokumente, die zwischen Tools wandern könnten, ist CommonMark plus dokumentierte Erweiterungen besser.

Markdown-Grundlagen

Überschriften

Verwende ein bis sechs Hash-Zeichen. Eines ist die größte Überschrift.

# Überschrift 1

## Überschrift 2

### Überschrift 3

Absätze und Zeilenumbrüche

Trenne Absätze durch eine Leerzeile. Beende eine Zeile mit zwei Leerzeichen oder einem Backslash für einen erzwungenen Umbruch.

Das ist der erste Absatz.

Das ist der zweite.

Betonung

_kursiv_ oder _kursiv_
**fett** oder **fett**
**_fett und kursiv_**
~~durchgestrichen~~ (nur GFM)

Listen

Unsortierte Listen verwenden -, * oder +:

- Punkt eins
- Punkt zwei
  - Unterpunkt

Nummerierte Listen verwenden Zahlen:

1. Schritt eins
2. Schritt zwei
3. Schritt drei

Die Zahlen müssen nicht korrekt sein. Markdown nummeriert beim Rendern neu. Trotzdem sollte man fortlaufende Zahlen verwenden, damit der Quelltext lesbar bleibt.

[Linktext](https://example.com)
[Link mit Titel](https://example.com "Titel")
![Alternativtext](https://example.com/image.png)

Für interne Links verwendet man relative Pfade:

[Markdown zu PDF konvertieren](/tools/markdown-to-pdf)

Code

Inline-Code wird mit einfachen Backticks markiert: `console.log("hi")`.

Code-Blöcke verwenden drei Backticks:

```python
def hello():
    return "hello"
```

Füge nach den öffnenden Backticks einen Sprachidentifier hinzu, damit Syntax-Highlighter arbeiten können.

## Häufige Tricks und Beispiele

### Zitate

```markdown
> Das ist ein Zitat.
> Es kann sich über mehrere Zeilen erstrecken.

Zitate können verschachtelt werden:

> Äußeres Zitat
>
> > Inneres Zitat

Horizontale Linien

---

Verwende drei oder mehr Bindestriche, Sterne oder Unterstriche allein in einer Zeile.

Aufgabenlisten

GFM unterstützt Kontrollkästchen:

- [x] Entwurf schreiben
- [ ] Tabellen prüfen
- [ ] Beitrag veröffentlichen

Sie werden in HTML als deaktivierte Kontrollkästchen gerendert. Ersetzen sie nicht durch echte Formulareingaben.

Maskieren von Zeichen

Stelle Markdown-Zeichen mit einem Backslash voran, wenn sie wörtlich erscheinen sollen:

\*nicht kursiv\*
\# keine Überschrift

Fortgeschrittene Tricks und Beispiele

Tabellen

Tabellen sind eine GFM-Erweiterung, nicht Teil der ursprünglichen Markdown-Spezifikation.

| Feature        | CommonMark | GFM |
| -------------- | ---------- | --- |
| Tabellen       | Nein       | Ja  |
| Aufgabenlisten | Nein       | Ja  |

Ausrichtung ist optional:

| Links | Mitte | Rechts |
| :---- | :---: | -----: |
| A     |   B   |      C |

Halte Tabellen einfach. Verschachtelte Tabellen, verbundene Zeilen oder Spalten sind nicht standardisiert und funktionieren oft nicht.

Fußnoten

Pandoc und einige GFM-Parser unterstützen Fußnoten:

Hier ist eine Aussage.[^1]

[^1]: Das ist der Fußnotentext.

Wenn du Fußnoten in ein gerendertes PDF brauchst, verwende einen Converter, der Pandoc-Syntax unterstützt, oder füge sie manuell ein.

Mathematik

Pandoc und viele moderne Editoren unterstützen LaTeX-Mathematik:

Inline-Mathe: $E = mc^2$

Block-Mathe:

$$
\int_a^b f(x) \, dx = F(b) - F(a)
$$

Die Darstellung hängt vom Parser und Ausgabeformat ab. HTML benötigt meist MathJax oder KaTeX. PDF-Converter benötigen oft ein LaTeX-Backend.

Definitionslisten

Eine weitere Pandoc-Erweiterung:

Begriff
: Definition des Begriffs.

Ein anderer Begriff
: Eine andere Definition.

HTML innerhalb von Markdown

Wenn Markdown nicht ausreicht, kann man auf HTML zurückgreifen:

<p style="color: red;">Dieser Text ist rot.</p>

Das hilft bei Layout, eingebetteten Videos oder Attributen, die Markdown nicht unterstützt. Es kostet aber Portabilität, also sparsam verwenden.

Wann man Markdown konvertiert

Markdown ist großartig fürs Schreiben und Versionsmanagement. Es ist schlecht für finale Dokumente, die überall identisch aussehen müssen. Deshalb gibt es Converter.

Wenn ein Markdown-Entwurf zu einem teilbaren PDF werden soll, verwende den Markdown-zu-PDF-Converter. Er läuft im Browser, die Datei verlässt also nicht deinen Rechner.

Wenn du von einem PDF ausgehst und bearbeitbares Markdown brauchst, verwende den PDF-zu-Markdown-Converter. Er extrahiert Überschriften, Listen und Absätze, ohne etwas auf einen Server hochzuladen.

Markdown-Cheatsheet

ElementSyntaxBeispielausgabe
Überschrift 1# H1H1
Überschrift 2## H2H2
Überschrift 3### H3H3
Fett**bold**bold
Kursiv*italic*italic
Durchgestrichen~~text~~text
Inline-Code`code`code
Link[text](url)text
Bild![alt](url)Bild
Zitat> quoteZitat
Unsortierte Liste- itemListenpunkt
Nummerierte Liste1. itemListenpunkt
Horizontale Linie---Horizontale Linie
Code-Block```langSyntax-highlighteter Block
Aufgabenliste- [ ] taskKontrollkästchen
Tabelle| a | b |Tabelle

Drucke diese Tabelle aus und klebe sie an deinen Monitor. Dann musst du die Markdown-Syntax kaum noch nachschlagen.

Schlussbemerkung

Markdown belohnt Zurückhaltung. Verwende die Kernsyntax für 90% dessen, was du schreibst. Greife nur bei Bedarf zu Tabellen, Fußnoten und HTML. Wenn du dich an CommonMark oder GFM hältst, können deine Dateien zwischen Editoren, Plattformen und Converter ohne Überraschungen wandern.

Mehr Blog-Posts zum Lesen