Markdown ist eine leichtgewichtige beziehungsweise vereinfachte Auszeichnungssprache. Mit ihr lassen sich Formatierungselemente zu Textdokumenten hinzufügen, deren Ausgangsform Klartext ist.[1]
Entstehung
Markdown wurde 2004 von John Gruber entwickelt.[2]
Listen
Markdown unterstützt sowohl geordnete als auch ungeordnete Listen.[3] In einer ungeordneten Liste können die Zeichen *, + oder - als Markierungen der einzelnen Listenpunkte verwendet werden.[4] Ein untergeordneter Listenpunkt kann durch vier Leerzeichen eingerückt werden.[4] Bei einer geordneten Liste werden die einzelnen Punkte nummeriert.[3] Damit stehen für Aufzählungen eine nummerierte Form und eine Form mit nicht nummerierten Listenmarkierungen zur Verfügung.[3]
Varianten
Markdown-Anwendungen implementieren häufig jeweils leicht unterschiedliche Versionen der Auszeichnungssprache. Solche Varianten werden als „Flavors“ bezeichnet.[1] Der Begriff bezeichnet damit Unterschiede zwischen den in einzelnen Anwendungen umgesetzten Markdown-Syntaxen.[1]
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.[5]
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.[6] Alle nachfolgenden Überschriften sollen auf der Ebene H2 oder einer tieferen Ebene beginnen.[6] Nach dieser Regel wird H1 nicht erneut für einen späteren Abschnitt verwendet; die Abschnittsgliederung unterhalb des Dokumenttitels setzt mit H2 oder tiefer ein.[6]
Der Styleguide empfiehlt außerdem, nach Möglichkeit die Standardsyntax von Markdown zu verwenden und HTML-Behelfslösungen zu vermeiden.[6] Ist eine Auszeichnung mit Markdown-Syntax möglich, wird diese damit gegenüber einer ersatzweisen HTML-Konstruktion bevorzugt.[6] Die Empfehlungen betreffen somit sowohl die Hierarchie der Überschriften als auch die Wahl der Auszeichnungssyntax.[6]
Einzelnachweise
- ↑ 1,0 1,1 1,2 Markdown Guide: Getting Started | Markdown Guide, 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.
- ↑ 3,0 3,1 3,2 Markdown Syntax-Dokumentation: markdown.de | Markdown Syntax-Dokumentation, abgerufen am 13. Juli 2026.
- ↑ 4,0 4,1 Markdown: Markdown – Wikipedia, abgerufen am 13. Juli 2026.
- ↑ RFC 7764: Guidance on Markdown: Design Philosophies, Stability Strategies, and Select Registrations, abgerufen am 13. Juli 2026.
- ↑ 6,0 6,1 6,2 6,3 6,4 6,5 Markdown style guide: Markdown style guide, styleguide, abgerufen am 13. Juli 2026.