Markdown

Grundidee und Funktionsweise

Markdown ist eine vereinfachte Auszeichnungssprache. Sie wurde von John Gruber entworfen und im Dezember 2004 mit Version 1.0.1 spezifiziert; Aaron Swartz war einziger Beta-Tester und half maßgeblich bei der Entwicklung der Syntax. Die Dateiendungen sind .md und .markdown, der MIME-Type lautet text/markdown.

Das zentrale Ziel ist, dass die Ausgangsdatei schon vor der Umwandlung leicht lesbar bleibt. Deshalb verwendet Markdown vor allem Zeichen, die aus Plain text und E-Mails bekannt sind. Auch reStructuredText und Textile beeinflussten die Syntax. Eine Konvertierungssoftware wandelt Markdown-Text in gültiges und W3C-konformes HTML um. Die Referenzimplementierung in Perl steht unter einer BSD-artigen Lizenz; Implementierungen gibt es unter anderem für PHP, Python, JavaScript und R.

Wichtige Auszeichnungen

Normaler Text wird wie eingegeben dargestellt. Eine Leerzeile erzeugt einen Absatz, zwei oder mehr Leerzeichen am Ende einer Zeile einen Zeilenumbruch. Sonderzeichen mit Formatierungswirkung lassen sich mit einem Backslash maskieren, sodass sie als normale Zeichen erscheinen.

Für Betonungen stehen gleichwertige Schreibweisen zur Verfügung: Kursiv oder Kursiv, Fett oder Fett sowie Fett kursiv oder Fett kursiv. Text zwischen einfachen Backticks wird als Inline-Quelltext markiert. Ein um vier Leerzeichen eingerückter Bereich wird zu einem Code-Block.

Ungeordnete Listen beginnen mit *, + oder −; Unterpunkte werden um vier Leerzeichen eingerückt. Geordnete Listen beginnen mit Ziffern und Punkten. Dabei müssen die eingegebenen Ziffern nicht die tatsächliche Reihenfolge bilden; auch dieselbe Ziffer kann mehrfach verwendet werden.

Überschriften entstehen mit # am Zeilenanfang; die Anzahl der Doppelkreuze bestimmt die Ebene, etwa # für Ebene 1 und #### für Ebene 4. Für die ersten zwei Ebenen gibt es außerdem die Unterstreichung mit === beziehungsweise ---. Ein > leitet ein Zitat als HTML-Blockquote ein. Drei oder mehr Bindestriche, Unterstriche oder Sternchen in einer Zeile erzeugen eine horizontale Linie. Links verwenden die Form Beschriftung, Bilder die Form .

Einsatzbereiche und Werkzeuge

Markdown oder eine ähnliche Syntax wird auf Entwicklungsplattformen wie GitHub, GitLab und Forgejo, in technischen Foren wie Stack Overflow und sehr häufig in Readme-Dateien verwendet. Google Docs und Trello nutzen Markdown ebenfalls. Content-Management-Systeme, Wikis und Foren können Markdown oft per Plug-in ergänzen; Ghost unterstützt es nativ. Plug-ins gibt es unter anderem für WordPress, Joomla und MediaWiki. Flat-File-Content-Management-Systeme wie Kirby sowie statische Webseiten-Generatoren wie Jekyll, Hugo und Hexo verwenden Markdown für Inhalte. Auch Doxygen nutzt es.

Matrix und Webex unterstützen Markdown vollumfänglich, WhatsApp und Slack nur teilweise. Viele Markdown-Editoren zeigen zusätzlich sofort eine HTML-Vorschau an. Andere richten sich an Nutzer klassischer Textverarbeitungen oder von LaTeX: Sie können Dokumente beispielsweise als gängige Textverarbeitungsformate, PDF und teilweise LaTeX speichern und zeigen Formatierungen direkt oder in einem Vorschau-Bereich. Markdown ist besonders beim ablenkungsfreien Schreiben verbreitet, wird aber auch für Notizen, Dokumente und Präsentationen eingesetzt.

Erweiterungen und Varianten

Die ursprüngliche Markdown-Definition enthält einige gebräuchliche Elemente, etwa Tabellen, nicht. Deshalb ist HTML in Markdown-Dokumenten erlaubt; Erweiterungen schließen weitere Lücken. Markdown Extra ergänzt unter anderem Tabellen, Definitionslisten, Abkürzungen, Fußnoten, Sprungmarken sowie Klassen und IDs. CommonMark wurde nach einer im Oktober 2012 angeregten Standardisierung am 5. September 2014 als eigene Definition veröffentlicht.

GitHub Flavored Markdown baut auf CommonMark auf und ergänzt Code-Blöcke, Tabellen, Checklisten, durchgestrichenen Text, erweiterte Autolinks sowie Referenzen auf Benutzerprofile, Changesets und Tickets. Markdown-Tag rendert unter anderem CommonMark und GitHub Flavored Markdown mittels JavaScript im Browser, sodass der Server MD-Dateien nicht nach HTML übersetzen muss.

MultiMarkdown erweitert die Syntax um Fußnoten, Tabellen, Glossare, Zitate und Metadaten wie Titel, Autor und Datum und exportiert zusätzlich nach LaTeX und PDF. Pandoc Markdown kann Markdown unter anderem in LaTeX, XML, ePUB, PDF, MediaWiki und DokuWiki transformieren und ergänzt beispielsweise Tabellen, Definitionslisten, Mathematikmodus, eingebettetes TeX, Bildunterschriften, Fußnoten und Bibliographien nach CSL.

Weitere Varianten sind Stack Overflow Flavored Markdown mit Tags, Spoilern und Syntax-Highlighting, Markdeep mit Diagrammen, Kalendern und LaTeX-Formeln, sowie LiaScript für interaktive Lehrinhalte mit Animationen, Sprachausgabe, KaTeX-Formeln, Quizzen und Umfragen. Djot leitet vieles von CommonMark ab, vereinfacht einige schwer effizient zu parsende Punkte und ergänzt unter anderem Definitionslisten, Fußnoten, Tabellen, mathematische Notation, Attribute und generische Container.