Cheatsheet
GitHub-Flavored Markdown Cheatsheet — GFM-Syntax für Issues, PRs, READMEs
GitHub-Flavored Markdown (GFM) erweitert CommonMark um die Features, die das tagliche Arbeiten in Issues, Pull-Requests und READMEs braucht. Tabellen, Task-Lists und Autolinks sind GFM-Erweiterungen.
Quelle: GitHub Flavored Markdown Spec
GFM als de-facto-Web-Standard
GitHubs Markdown-Renderer hat sich seit 2008 zur wichtigsten Markdown-Variante im Web entwickelt. Viele andere Plattformen — GitLab, Bitbucket, Forem (dev.to), Discourse — haben GFM übernommen oder eng angelehnt.
GFM-Spezifikation ist ein Superset von CommonMark 0.29. Jeder gültige CommonMark-Code läuft auch als GFM. Die Umkehrung gilt nicht: GFM-Tabellen oder Task-Lists in einem reinen CommonMark-Renderer werden als Plain-Text dargestellt.
Tabellen, Task-Lists, Autolinks
Tabellen mit Pipe-Syntax sind das wichtigste GFM-Feature. Drei Mindest-Spalten, Trenn-Zeile mit `:---:` für Ausrichtung, dann Datenzeilen.
Task-Lists werden mit `- [ ]` (offen) und `- [x]` (erledigt) markiert. GitHub rendert sie als interaktive Checkboxen, andere Renderer als unicode-Boxen.
Autolinks ohne `<>` funktionieren bei nackten URLs: `https://github.com` wird automatisch verlinkt. Bei E-Mail-Adressen geht das auch.
Syntax-Übersicht
| Feature | Syntax |
|---|---|
| Alle CommonMark-Features | — siehe CommonMark-Cheatsheet |
| Tabellen | | Spalte 1 | Spalte 2 | |----|----| | Daten | Daten | |
| Tabellen-Ausrichtung | | L | M | R | |:---|:---:|---:| |
| Task-Lists | - [ ] Offen - [x] Erledigt |
| Strikethrough | ~~durchgestrichen~~ |
| Autolinks (nackte URL) kein <> nötig | https://github.com |
| Footnoten | Text[^1] [^1]: Fußnote |
| Issue/PR-Referenzen GitHub-spezifisch | #123 oder GH-123 |
| User-Mentions GitHub-spezifisch | @username |
| Emoji-Shortcodes GitHub-Renderer | :rocket: :tada: |
| Code-Block-Sprache | ```javascript code ``` |
| Eingebettetes HTML sicher gefiltert | <details><summary>... |
Was GitHub-Flavored Markdown (GFM) NICHT unterstützt
- Math / KaTeX (seit 2022 mit eingeschränkter Dollar-Math-Syntax)
- Mermaid (nur in GitHub-Issues mit ```mermaid)
- Wikilinks `[[Note]]`
- Front-Matter (YAML)
Häufige Fragen
Was ist der Unterschied zwischen GFM und CommonMark?
GFM ist eine Erweiterung von CommonMark um Tabellen, Task-Lists, Strikethrough, Autolinks und Footnoten. Jeder CommonMark-Code läuft als GFM, aber nicht umgekehrt.
Unterstützt GitHub Math?
Seit 2022 ja, mit eingeschränkter Dollar-Math-Syntax: $E=mc^2$ inline, $$\\int_a^b$$ als Block. Vollständiges LaTeX wird nicht alles unterstützt.
Wie embed ich Mermaid in GitHub?
In Issues und PR-Beschreibungen mit ```mermaid-Code-Block. In README.md auf GitHub.com wird Mermaid ebenfalls gerendert.
Welche HTML-Tags sind erlaubt?
Eine gefilterte Whitelist: <details>, <summary>, <kbd>, <sub>, <sup>, <br>, <img>, <a> mit Attributen. Scripts und Style-Tags werden entfernt.
Markdown jetzt im Editor schreiben
Live-Vorschau, Auto-Save, HTML- und PDF-Export — alles im Browser.
Zum Editor