Markdown ist eine Auszeichnungssprache für Fließtext, die sich auch ungerendert lesen lässt. Aus ihr entsteht meist HTML.
- Markdown
Eine schlanke Auszeichnungssprache, die Formatierung mit Satzzeichen ausdrückt und sich auch als reiner Text lesen lässt.
Beispiel: „Die Dokumentation liegt in Markdown, damit sie in jedem Editor lesbar bleibt.“Herkunft: John Gruber und Aaron Swartz stellten es 2004 vor. Der Name spielt auf markup an und dreht es um: weniger Auszeichnung statt mehr.
Der Grundgedanke
Die Zeichen, mit denen Menschen in E-Mails ohnehin hervorhoben, wurden zur Sprache erklärt. Sternchen für Hervorhebung, Doppelkreuze für Überschriften, Bindestriche für Aufzählungen. Das Ergebnis liest sich auch ohne Darstellung.
Genau darin liegt der Unterschied zu HTML. Eine HTML-Datei ist im Rohzustand mühsam zu lesen, eine Markdown-Datei nicht.
# Überschrift erster Ordnung
Ein Absatz mit **fett** und *kursiv*.
- erster Punkt
- zweiter Punkt
[Ein Link](https://beispiel.de/) und `Code im Text`.Wo es im Projektalltag steckt
In den Dateien, die in Code-Repositories die Dokumentation tragen, in Fehlermeldungen und Kommentaren auf Plattformen wie GitHub, in Notizwerkzeugen und in den Anweisungsdateien, mit denen dieses Projekt arbeitet.
Dazu kommen Redaktionssysteme, die Inhalte darin ablegen. Der Vorteil: Der Inhalt bleibt lesbar, auch wenn das System einmal nicht mehr da ist.
Dass es keinen einheitlichen Standard gibt
Die ursprüngliche Beschreibung ließ Fragen offen, und daraus sind Dialekte entstanden. Tabellen, Fußnoten und Aufgabenlisten kennt nicht jede Umsetzung gleich.
CommonMark ist der Versuch einer verbindlichen Festlegung und hat sich weitgehend durchgesetzt. Bei Tabellen lohnt trotzdem ein Blick, welche Erweiterung das jeweilige Werkzeug unterstützt.