Markdown: Anleitung für die einfache Aus­zeich­nungs­spra­che

Wenn wir Texte lesen, ganz egal ob im Internet, in einer Zeit­schrift oder einem ge­druck­ten Buch, erwarten wir ein be­stimm­tes Format. Besonders wichtige Wörter sind gefettet, eine Über­schrift lässt sich mit einem Blick vom rest­li­chen Text un­ter­schei­den und mit einer or­dent­li­chen Liste wird das Ge­schrie­be­ne an­schau­li­cher. Wir nehmen solche For­ma­tie­run­gen als selbst­ver­ständ­lich wahr, und wenn wir selbst einen Text am PC verfassen, gelingt uns das meist ohne Probleme: Schrift­grö­ße anpassen, Spie­gel­stri­che setzen und Wörter fetten. Jedes Text­ver­ar­bei­tungs­pro­gramm bietet Nutzern die un­ter­schied­lichs­ten Mög­lich­kei­ten, um ihr Ge­schrie­be­nes an­spre­chend zu gestalten.

Aber das ist keine Selbst­ver­ständ­lich­keit. Prin­zi­pi­ell markieren Sie in solchen Si­tua­tio­nen den Text, und die Software stellt diesen daraufhin so dar, wie Sie es sich wünschen. Den ei­gent­li­chen Quelltext inklusive Aus­zeich­nungs­ele­men­te (die Mar­kie­run­gen) bekommt man bei Word & Co. gar nicht zu sehen. Und man könnte damit auch nicht viel anfangen: Für Menschen ist dieser Code nämlich kaum zu lesen.

Sprachen wie HTML oder LaTeX kann man zwar mit jedem Text­edi­tor schreiben, aber sie lassen sich für Menschen nicht gut ent­zif­fern. Die ver­ein­fach­te Aus­zeich­nungs­spra­che Markdown will genau das ändern. Sie will das Beste aus beiden Welten: sowohl für Maschinen als auch für Menschen ver­ständ­lich sein. Markdown verwendet selbst­er­klä­ren­de Elemente, um den Text zu for­ma­tie­ren. So ist auch ein damit aus­ge­zeich­ne­ter Text relativ leicht von Menschen zu lesen.

Genau wie HTML – oder auch LaTeX – ist Markdown eine Aus­zeich­nungs­spra­che. Im Gegensatz zu den genannten soll Markdown aber möglichst leicht von Menschen zu lesen sein. Jedes Aus­zeich­nungs­ele­ment soll nicht abstrakt, sondern nah an der ei­gent­li­chen Bedeutung sein. Am ein­fachs­ten lässt sich das Prinzip an einem Beispiel erklären: Möchte man in HTML ein Wort fett her­vor­he­ben, nutzt man dafür entweder das <b>- oder das <strong>-Tag.

Schreiben Sie hingegen ein Dokument in LaTeX, verwenden Sie (im Fließtext-Modus) das Element \textbf.

Beides ist zwar ei­ni­ger­ma­ßen gut zu lesen, aber schon etwas schwie­ri­ger zu schreiben, besonders, wenn man an längere Texte denkt. Markdown ver­ein­facht dies, indem fett­ge­druck­te Passagen einfach in Sternchen gesetzt werden.

Diese Version ist zum einen einfacher zu lesen, denn das Sternchen macht die Her­vor­he­bung direkt klar, und zum anderen sind die vier Zeichen sehr viel schneller zu tippen als Tags. Bereits ohne Kon­ver­tie­rung (also im Plain Text) kann ein Leser leicht fest­stel­len, was der Verfasser meint – selbst wenn man die Markdown-Syntax nicht be­herrscht.

Das macht Markdown vor allem für solche Nutzer in­ter­es­sant, die zwar keinen IT-Hin­ter­grund haben und auch keine Webdesign-Kennt­nis­se besitzen, aber dennoch re­gel­mä­ßig Texte für das Internet verfassen: Blogger, die mit einem Content-Ma­nage­ment-System (CMS) arbeiten bei­spiels­wei­se. Aber auch tech­nik­af­fi­ne Menschen greifen zu Markdown, wenn sie einfache Texte verfassen. So verwenden manche Pro­gram­mie­rer die Markdown Language, um be­glei­ten­de Dokumente (z. B. Readme-Dateien) zu verfassen, die gar nicht erst kon­ver­tiert werden. Ob der Nutzer den Text in einem Markdown-Viewer öffnet oder im rohen Zustand liest, macht kaum einen Un­ter­schied in puncto Les­bar­keit.

Für die be­kann­tes­ten CMS wie WordPress oder Joomla exis­tie­ren Plug-ins, die es den Systemen er­mög­li­chen, Markdown zu verstehen. Auch viele Wikis, Foren (reddit bei­spiels­wei­se) sowie der Website-Generator Jekyll können mit der ver­ein­fach­ten Aus­zeich­nungs­spra­che umgehen.

Markdown versucht kein Ersatz zu HTML zu sein, dafür ist der Umfang der Ge­stal­tungs­mög­lich­kei­ten auch viel zu gering. Die Ent­wick­ler der Sprache sehen Markdown eher als Ergänzung. Es ist möglich, HTML-Elemente in ein Markdown-Dokument ein­zu­fü­gen und so das Spektrum der relativ simpel ge­hal­te­nen Sprache zu erweitern. Vielmehr soll die Markdown Language dazu dienen, das Schreiben (vor allem im Internet) zu ver­ein­fa­chen. Wenn Markdown-Dokumente vom Parser um­ge­wan­delt werden, entstehen z. B. HTML-Dateien, um die Anzeige in Browsern zu er­mög­li­chen.

Da Markdown das Ziel hat, eine möglichst einfache Aus­zeich­nungs­spra­che zu sein, ist auch die Markdown-Syntax nahezu selbst­er­klä­rend. Dennoch müssen Sie die Aus­zeich­nungs­ele­men­te zunächst kennen, bevor Sie sie einsetzen können. Wir haben die wich­tigs­ten Funk­tio­nen für Sie zu­sam­men­ge­tra­gen.

Besonders einfach lassen sich mit Markdown Fettungen und Kur­si­vie­run­gen erstellen. Dafür sind nur Sternchen – die so­ge­nann­ten Asteriske – notwendig. Um kursiv zu schreiben, setzen Sie je ein Sternchen vor und nach dem Wort oder den Wörtern. Für Fettungen verwenden Sie zwei, und möchten Sie einen Text­be­reich sowohl fett als auch kursiv setzen, benutzen Sie drei Sternchen. Al­ter­na­tiv können Sie Un­ter­stri­che verwenden.

Um einen durch­ge­stri­chen Text dar­zu­stel­len, nutzt man bei Markdown die Tilde zweimal hin­ter­ein­an­der, lässt dann den ent­spre­chen­den Text folgen und schließt das Element wieder mit zwei Tilden ab.

Um eine Über­schrift in Markdown zu erzeugen, nutzt man stan­dard­mä­ßig eine Raute. Diese setzt man mit einem Leer­zei­chen Abstand vor den Text. Um Über­schrif­ten zu erstellen, die hier­ar­chisch tiefer liegen und demnach kleiner ge­schrie­ben sind, setzen Sie zu­sätz­li­che Rauten ein. Auf diese Weise lassen sich wie in HTML Über­schrif­ten bis zur sechsten Stufe erstellen.

Als Al­ter­na­ti­ven lassen sich auch Gleich­heits­zei­chen und Bin­de­strich zur Mar­kie­rung von Über­schrif­ten einsetzen. Diese setzt man in die Zeile unter die ei­gent­li­che Über­schrift. Mit dieser Variante können Sie also nur zwei un­ter­schied­li­che Über­schrif­ten­grö­ßen erzeugen. Ein Zeichen pro Über­schrift reicht voll­kom­men aus, obwohl man vielfach mehrere Zeichen ne­ben­ein­an­der sieht. Das hat rein optische Gründe, da es dann so wirkt, als wäre der Text ein- oder zweifach un­ter­stri­chen.

Die Markdown Language arbeitet mit harten Zei­len­um­brü­chen, um Absätze von­ein­an­der zu trennen. Um einen komplett neuen Textblock zu erstellen (<p>-Tag), fügt man einfach eine leere Zeile ein. Wichtig hierbei zu wissen: Für Markdown reicht es aus, wenn die Zeile optisch leer ist. Sollten sich also Weißraum-Zeichen wie Ta­bu­la­to­ren oder Leer­zei­chen darin befinden, ignoriert der Parser diese und in­ter­pre­tiert die Zeile als leer. Möchte man einen Zei­len­um­bruch im Sinne des <br>-Tags erstellen, fügt man an das Ende einer Zeile zwei Leer­zei­chen an.

Um einen be­stimm­ten Text­be­reich als Zitat zu kenn­zeich­nen, können Sie mit Markdown ein so­ge­nann­tes Block­quo­te-Element erzeugen. Hierfür verwenden Sie das Größer-als-Zeichen (>). Sie haben die Mög­lich­keit, entweder jede einzelne Zeile mit diesem Zeichen zu kenn­zeich­nen oder nur eines an den Anfang des Absatzes zu setzen und den ein­ge­rück­ten Bereich mit einer Leerzeile zu beenden. Im Block­quo­te-Element sind weitere For­ma­tie­rungs­ele­men­te möglich.

Um mit Markdown eine un­sor­tier­te Liste zu erstellen, verwenden Sie entweder das Plus-Zeichen, den Bin­de­strich oder ein Sternchen. Alle drei Varianten werden zum gleichen Ergebnis führen.

Eine sortierte Liste hingegen erzeugt man durch eine Zahl mit einem direkt dar­auf­fol­gen­den Punkt.

Markdown gibt Ihnen zu­sätz­lich die Mög­lich­keit, Check­lis­ten zu erstellen. Diese er­schei­nen mit einem Kästchen, das per Knopf­druck aktiviert werden kann. Sie können auch bereits beim Erstellen der Liste Häkchen setzen. Nutzen Sie hierfür eckige Klammern und ein X.

Um einen Text­be­reich als Code zu kenn­zeich­nen, nutzt man bei Markdown den so­ge­nann­ten Backtick, auch als Gravis oder accent grave bekannt – nicht zu ver­wech­seln mit dem einfachen An­füh­rungs­zei­chen. Einen Akzent am Anfang und einen am Ende des ent­spre­chen­den Text­be­rei­ches erstellt die Mar­kie­rung. Auf diese Weise lassen sich Quellcode oder Software-Befehle direkt in den Fließtext ein­glie­dern.

Sollte in Ihrem Code­bei­spiel selbst der Backtick vorkommen, können Sie zu Anfang des Code­ab­schnitts auch das Zeichen doppelt verwenden. So wertet Markdown den einfachen Backtick nicht als Signal.

Um einen ganzen Block als Quellcode zu markieren, kann man entweder einen Tabulator oder vier Leer­zei­chen verwenden – und zwar für jede Zeile. Um aus­ge­wähl­te Zeilen noch weiter einrücken zu lassen, fügen Sie einfach weitere Ta­bu­la­to­ren oder Leer­zei­chen hinzu.

Wer lieber Zeichen zum Einleiten und Beenden von Code-Blöcken verwendet, kann den ent­spre­chen­den Bereich auch mit je drei Backticks am Anfang und am Ende markieren. Hier haben Sie zu­sätz­lich – je­den­falls bei vielen Markdown-Editoren – die Mög­lich­keit, farbige Her­vor­he­bun­gen au­to­ma­tisch zu erstellen. Hierfür geben Sie nach den drei ein­lei­ten­den Backticks die Sprache an, in der der dar­auf­fol­gen­de Quellcode verfasst wurde.

Mit Markdown können Sie auch Bilder und Hy­per­links in Ihren Text in­te­grie­ren. Beides entsteht durch eine Kom­bi­na­ti­on aus eckigen und runden Klammern. Einen Link erzeugen Sie, indem Sie den Ankertext – also die Wörter oder Phrasen, die im Text zu sehen sind – in eckige Klammern setzen und direkt darauf in runden Klammern die URL anfügen. Möchten Sie den Hyperlink noch mit einem op­tio­na­len Titel versehen, den der Nutzer sieht, wenn er mit dem Maus­zei­ger dar­über­fährt, ist auch dies möglich: Der Text kommt mit in die runden Klammern, von der URL mit einem Leer­zei­chen getrennt und in doppelte An­füh­rungs­zei­chen gesetzt.

Wenn Sie eine URL oder eine E-Mail-Adresse in den normalen Fließtext einfügen, werden die meisten Markdown-Editoren au­to­ma­tisch einen klick­ba­ren Hyperlink erzeugen. Um dies zu forcieren, setzen Sie Kleiner- und Größer-als-Zeichen ein. Um auf der anderen Seite die Automatik der Editoren zu ver­hin­dern, markieren Sie die URL als Code und nutzen dafür erneut Backticks.

Ähnlich wie Hy­per­links lassen sich auch Bilder in das Markdown-Dokument einfügen. Hier beginnt man al­ler­dings mit einem Aus­ru­fe­zei­chen. Im Anschluss kommen wieder eckige Klammern zum Einsatz, in denen sich der al­ter­na­ti­ve Text zum Bild befindet, und runde Klammern mit der URL zum Bild. Dieses wird an­schlie­ßend direkt im Text dar­ge­stellt.

Bilder und Hy­per­links lassen sich auch kom­bi­nie­ren. Wenn Sie hinter das Bild einen klick­ba­ren Link setzen möchten, ver­schach­teln Sie die beiden Funk­tio­nen mit­ein­an­der. Das Bild wird hier zum Ankertext und taucht deshalb in den eckigen Klammern auf.

Mit Pipes (|) lassen sich in Markdown Tabellen zeichnen. Jede Zelle wird durch eine Pipe getrennt. Um Kopf­zei­len zu erzeugen, die sich optisch vom rest­li­chen Inhalt absetzen, un­ter­streicht man die ent­spre­chen­den Zellen mit Bin­de­stri­chen.

Es ist prin­zi­pi­ell nicht wichtig, dass die Pipes un­ter­ein­an­der sind. Dies erhöht nur die Les­bar­keit, wenn das Markdown-Dokument in seiner Roh­fas­sung angesehen wird. Gleiches gilt für die Pipes, die an den Seiten zu finden sind. Auch diese sind für das Kom­pi­lie­ren un­er­heb­lich.

Markdown gibt Ihnen die Mög­lich­keit, Fußnoten zu setzen. In den Fließtext schreiben Sie eine An­mer­kungs­zif­fer und lösen diese am Ende der Seite in der Fußnote auf – eine ent­spre­chen­de Linie wird dabei au­to­ma­tisch erzeugt. Die An­mer­kungs­zif­fer ist zudem als Hyperlink for­ma­tiert, sodass man bei einem Klick darauf direkt zur ent­spre­chen­den Fußnote gelangt. Um diese au­to­ma­ti­sche Funktion nutzen zu können, setzen Sie zuerst die An­mer­kungs­zif­fer hinter das ge­wünsch­te Wort: In eckigen Klammern schreibt man erst ein Zir­kum­flex und dann die Nummer.

Welche Nummer (auch andere Begriffe sind möglich) Sie einsetzen, ist un­er­heb­lich. Wie beim Erstellen von Listen übernimmt Markdown die Zählung au­to­ma­tisch für Sie. Wichtig ist al­ler­dings, dass Sie die gewählte Be­zeich­nung auch wieder korrekt auflösen. Dafür setzen Sie die gleiche Ziffer in einer neuen Zeile wieder mit Zir­kum­flex in eine Klammer, fügen einen Dop­pel­punkt hinzu und schreiben dann die ei­gent­li­che Anmerkung. Diese kann zu­sätz­lich umfassend for­ma­tiert werden und sich auch über mehrere Zeilen er­stre­cken.

Da Markdown eng verwandt mit HTML ist, bedürfen das kauf­män­ni­sche Und- sowie Kleiner- und Größ­erzei­chen einen be­son­de­ren Fokus. Diese Zeichen werden in HTML verwendet, um Tags zu öffnen und zu schließen (<>) oder um mit Entities zu arbeiten (&). Möchte man die Zeichen aber einfach in ihrer ur­sprüng­li­chen Bedeutung verwenden, muss man diese in HTML maskieren: &amp;, &lt; und &gt;. Prin­zi­pi­ell gibt es in Markdown keinen Grund, warum man die Zeichen nicht „wie sie sind“ einsetzen kann. Da Nutzer aber die Mög­lich­keit haben, Markdown mit HTML zu ver­mi­schen, wird der Fall komplexer. Damit Sie nicht selbst diese Schwie­rig­keit lösen müssen, versteht der Parser, wann Sie die einfachen Schrift­zei­chen haben möchten und wann Sie HTML-Code verwenden.

Neben den spe­zi­fi­schen Zeichen, die HTML mit sich bringt, nutzt eben auch Markdown bestimmte Symbole zur Aus­zeich­nung. Setzt man diese ein, reagiert der Parser beim Kon­ver­tie­ren darauf. Folgende Zeichen kommen hierfür in Frage:

• Asterisk: *
• Bin­de­strich:
• Un­ter­strich: _
• Runde Klammern: ()
• Eckige Klammern: []
• Ge­schweif­te Klammern: {}
• Punkt: .
• Aus­ru­fe­zei­chen: !
• Raute: #
• Gravis: `
• Backslash: \

Um diese Zeichen in ihrer ei­gent­li­chen Bedeutung zu verwenden, setzt man einfach jeweils einen Backslash davor. Wichtig: Der Backslash muss vor jedes einzelne Zeichen ge­schrie­ben werden; also bei­spiels­wei­se sowohl vor eine öffnende als auch vor eine schlie­ßen­de Klammer.