Markdown

Kurz: Eine einfache Schreibweise für formatierten Text, bei der man Überschriften, Listen und Links mit gewöhnlichen Zeichen wie #, - und * anlegt.

Genauer: Markdown wurde 2004 von John Gruber und Aaron Swartz entwickelt, um Text so zu schreiben, dass er auch unformatiert gut lesbar ist, und ihn dann in HTML umzuwandeln. Heute nutzen es README-Dateien auf GitHub, Wikis, Foren, Notiz-Apps und Dokumentationen. Dieses Wiki besteht selbst aus Markdown-Dateien.

Im Detail

Die wichtigsten Elemente

# Überschrift 1
## Überschrift 2
 
Ein Absatz mit **fett**, *kursiv* und `Code`.
 
- Liste mit Punkten
- noch ein Punkt
 
1. Nummerierte Liste
2. zweiter Punkt
 
> Ein Zitat
 
[Linktext](https://emzett-digital.com)

Ein Absatz endet mit einer Leerzeile. Code-Blöcke werden mit drei Backticks umrahmt, dahinter steht die Sprache für die Farbhervorhebung. Tabellen entstehen mit senkrechten Strichen und einer Trennzeile aus Strichen.

Varianten

Es gibt keinen einzigen Standard. CommonMark legt die Grundregeln eindeutig fest. GitHub Flavored Markdown (GFM) ergänzt Tabellen, Aufgabenlisten (- [x]), durchgestrichenen Text und automatische Links. Manche Programme fügen Fußnoten, Formeln oder Diagramme hinzu. Wer Dokumente zwischen Programmen austauscht, sollte bei den Grundelementen bleiben.

Sicherheit

Markdown darf HTML enthalten. Wenn Nutzer Markdown eingeben und die Seite es in HTML umwandelt, muss das Ergebnis bereinigt werden, sonst kann jemand Skripte einschleusen (XSS). Sichere Umsetzungen erlauben nur eine feste Liste von Elementen und prüfen Links (nur https:, http: und mailto:, niemals javascript:).

Wofür Markdown gut ist und wofür nicht

Gut: Dokumentation, Notizen, Blogtexte, alles, was in einem Versionsverwaltungssystem wie Git nachvollziehbar bleiben soll (Änderungen lassen sich als Diff vergleichen). Weniger gut: komplexe Layouts, genaue Seitengestaltung oder Formulare, dafür nimmt man HTML oder Textverarbeitungen.

Siehe auch: HTML, GitHub, Diff (Textvergleich)