Markdown ist eine leichtgewichtige beziehungsweise vereinfachte Auszeichnungssprache. Mit ihr lassen sich Formatierungselemente zu Textdokumenten hinzufügen, deren Ausgangsform Klartext ist.[1] Markdown ist eine einfache Textsyntax, mit der sich formatierte Inhalte für das Web ohne HTML-Kenntnisse erstellen lassen.[2][3]
Entstehung
Markdown wurde 2004 von John Gruber entwickelt.[4]
Grundlegende Syntax
Die grundlegende Markdown-Syntax umfasst unter anderem Überschriften, Absätze und Zeilenumbrüche, Hervorhebungen, Zitate, Listen, Code, horizontale Trennlinien, Links, Bilder und das Maskieren von Sonderzeichen.[5]
| Element | Eingabe → Ergebnis |
|---|---|
| Überschrift | ### Meine Überschrift → Überschrift der Ebene 3.[5]
|
| Fettdruck | **wichtiger Hinweis** → wichtiger Hinweis (fett).[5]
|
| Nummerierte Liste | 1. Erster Punkt → geordneter Listeneintrag.[5]
|
| Link | [Markdown Guide](https://www.markdownguide.org) → anklickbarer Text „Markdown Guide“.[5]
|
| Inline-Code | `datei.md` → Inline-Code.[5]
|
Absätze werden durch mindestens eine Leerzeile voneinander getrennt.[5][3] Werden alle Zeilen eines Blocks mit mindestens vier Leerzeichen oder einem Tabulator eingerückt, werden sie als Codeblock dargestellt.[5][3]
Listen
Markdown unterstützt sowohl geordnete als auch ungeordnete Listen.[6] In einer ungeordneten Liste können die Zeichen *, + oder - als Markierungen der einzelnen Listenpunkte verwendet werden.[6] Ein untergeordneter Listenpunkt kann durch vier Leerzeichen eingerückt werden.[6] Bei einer geordneten Liste werden die einzelnen Punkte nummeriert.[6]
Varianten
Markdown-Anwendungen implementieren häufig jeweils leicht unterschiedliche Versionen der Auszeichnungssprache. Solche Varianten werden als „Flavors“ bezeichnet.[1] Insbesondere werden erweiterte Syntaxelemente nicht von allen Markdown-Anwendungen unterstützt.[7][5]
RFC 7764 enthält Registrierungsvorlagen für mehrere solcher Syntaxen. Aufgeführt sind MultiMarkdown, GitHub Flavored Markdown, Pandoc, Fountain, CommonMark, kramdown-rfc2629, rfc7328 und PHP Markdown Extra.[8]
Praktische Strukturierung
Für konsistent strukturierte Markdown-Dokumente empfiehlt der Google-Styleguide eine einzige Überschrift der Ebene H1. Diese Überschrift dient als Titel des Dokuments.[9] Alle nachfolgenden Überschriften sollen auf der Ebene H2 oder einer tieferen Ebene beginnen.[9]
Der Styleguide empfiehlt außerdem, nach Möglichkeit die Standardsyntax von Markdown zu verwenden und HTML-Behelfslösungen zu vermeiden.[9]
Weblinks
Einzelnachweise
- ↑ 1,0 1,1 Markdown Guide: Getting Started | Markdown Guide, abgerufen am 13. Juli 2026.
- ↑ markdown.de: Markdown Syntax-Dokumentation, abgerufen am 13. Juli 2026.
- ↑ 3,0 3,1 3,2 Deutsche Schachjugend: Markdown, abgerufen am 13. Juli 2026.
- ↑ CommonMark and the Future of Scholarly Markdown: CommonMark and the Future of Scholarly Markdown, Front Matter, 7. September 2014, abgerufen am 13. Juli 2026.
- ↑ 5,0 5,1 5,2 5,3 5,4 5,5 5,6 5,7 5,8 Markdown Guide: Basic Syntax, abgerufen am 13. Juli 2026.
- ↑ 6,0 6,1 6,2 6,3 Markdown Syntax-Dokumentation: markdown.de | Markdown Syntax-Dokumentation, abgerufen am 13. Juli 2026.
- ↑ Markdown Guide: Markdown Cheat Sheet, abgerufen am 13. Juli 2026.
- ↑ RFC 7764: Guidance on Markdown: Design Philosophies, Stability Strategies, and Select Registrations, abgerufen am 13. Juli 2026.
- ↑ 9,0 9,1 9,2 Markdown style guide: Markdown style guide, styleguide, abgerufen am 13. Juli 2026.