Markdown: Anleitung für die einfache Auszeichnungssprache

Wenn wir Texte lesen, ganz egal ob im Internet, in einer Zeitschrift oder einem gedruckten Buch, erwarten wir ein bestimmtes Format. Besonders wichtige Wörter sind gefettet, eine Überschrift lässt sich mit einem Blick vom restlichen Text unterscheiden und mit einer ordentlichen Liste wird das Geschriebene anschaulicher. Wir nehmen solche Formatierungen als selbstverständlich wahr, und wenn wir selbst einen Text am PC verfassen, gelingt uns das meist ohne Probleme: Schriftgröße anpassen, Spiegelstriche setzen und Wörter fetten. Jedes Textverarbeitungsprogramm bietet Nutzern die unterschiedlichsten Möglichkeiten, um ihr Geschriebenes ansprechend zu gestalten.

Aber das ist keine Selbstverständlichkeit. Prinzipiell markieren Sie in solchen Situationen den Text, und die Software stellt diesen daraufhin so dar, wie Sie es sich wünschen. Den eigentlichen Quelltext inklusive Auszeichnungselemente (die Markierungen) 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 Texteditor schreiben, aber sie lassen sich für Menschen nicht gut entziffern. Die vereinfachte Auszeichnungssprache Markdown will genau das ändern. Sie will das Beste aus beiden Welten: sowohl für Maschinen als auch für Menschen verständlich sein. Markdown verwendet selbsterklärende Elemente, um den Text zu formatieren. So ist auch ein damit ausgezeichneter Text relativ leicht von Menschen zu lesen.

Genau wie HTML – oder auch LaTeX – ist Markdown eine Auszeichnungssprache. Im Gegensatz zu den genannten soll Markdown aber möglichst leicht von Menschen zu lesen sein. Jedes Auszeichnungselement soll nicht abstrakt, sondern nah an der eigentlichen Bedeutung sein. Am einfachsten lässt sich das Prinzip an einem Beispiel erklären: Möchte man in HTML ein Wort fett hervorheben, 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 einigermaßen gut zu lesen, aber schon etwas schwieriger zu schreiben, besonders, wenn man an längere Texte denkt. Markdown vereinfacht dies, indem fettgedruckte Passagen einfach in Sternchen gesetzt werden.

Diese Version ist zum einen einfacher zu lesen, denn das Sternchen macht die Hervorhebung direkt klar, und zum anderen sind die vier Zeichen sehr viel schneller zu tippen als Tags. Bereits ohne Konvertierung (also im Plain Text) kann ein Leser leicht feststellen, was der Verfasser meint – selbst wenn man die Markdown-Syntax nicht beherrscht.

Das macht Markdown vor allem für solche Nutzer interessant, die zwar keinen IT-Hintergrund haben und auch keine Webdesign-Kenntnisse besitzen, aber dennoch regelmäßig Texte für das Internet verfassen: Blogger, die mit einem Content-Management-System (CMS) arbeiten beispielsweise. Aber auch technikaffine Menschen greifen zu Markdown, wenn sie einfache Texte verfassen. So verwenden manche Programmierer die Markdown Language, um begleitende Dokumente (z. B. Readme-Dateien) zu verfassen, die gar nicht erst konvertiert werden. Ob der Nutzer den Text in einem Markdown-Viewer öffnet oder im rohen Zustand liest, macht kaum einen Unterschied in puncto Lesbarkeit.

Für die bekanntesten CMS wie WordPress oder Joomla existieren Plug-ins, die es den Systemen ermöglichen, Markdown zu verstehen. Auch viele Wikis, Foren (reddit beispielsweise) sowie der Website-Generator Jekyll können mit der vereinfachten Auszeichnungssprache umgehen.

Markdown versucht kein Ersatz zu HTML zu sein, dafür ist der Umfang der Gestaltungsmöglichkeiten auch viel zu gering. Die Entwickler der Sprache sehen Markdown eher als Ergänzung. Es ist möglich, HTML-Elemente in ein Markdown-Dokument einzufügen und so das Spektrum der relativ simpel gehaltenen Sprache zu erweitern. Vielmehr soll die Markdown Language dazu dienen, das Schreiben (vor allem im Internet) zu vereinfachen. Wenn Markdown-Dokumente vom Parser umgewandelt werden, entstehen z. B. HTML-Dateien, um die Anzeige in Browsern zu ermöglichen.

Da Markdown das Ziel hat, eine möglichst einfache Auszeichnungssprache zu sein, ist auch die Markdown-Syntax nahezu selbsterklärend. Dennoch müssen Sie die Auszeichnungselemente zunächst kennen, bevor Sie sie einsetzen können. Wir haben die wichtigsten Funktionen für Sie zusammengetragen.

Besonders einfach lassen sich mit Markdown Fettungen und Kursivierungen erstellen. Dafür sind nur Sternchen – die sogenannten 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 Textbereich sowohl fett als auch kursiv setzen, benutzen Sie drei Sternchen. Alternativ können Sie Unterstriche verwenden.

Um einen durchgestrichen Text darzustellen, nutzt man bei Markdown die Tilde zweimal hintereinander, lässt dann den entsprechenden Text folgen und schließt das Element wieder mit zwei Tilden ab.

Um eine Überschrift in Markdown zu erzeugen, nutzt man standardmäßig eine Raute. Diese setzt man mit einem Leerzeichen Abstand vor den Text. Um Überschriften zu erstellen, die hierarchisch tiefer liegen und demnach kleiner geschrieben sind, setzen Sie zusätzliche Rauten ein. Auf diese Weise lassen sich wie in HTML Überschriften bis zur sechsten Stufe erstellen.

Als Alternativen lassen sich auch Gleichheitszeichen und Bindestrich zur Markierung von Überschriften einsetzen. Diese setzt man in die Zeile unter die eigentliche Überschrift. Mit dieser Variante können Sie also nur zwei unterschiedliche Überschriftengrößen erzeugen. Ein Zeichen pro Überschrift reicht vollkommen aus, obwohl man vielfach mehrere Zeichen nebeneinander sieht. Das hat rein optische Gründe, da es dann so wirkt, als wäre der Text ein- oder zweifach unterstrichen.

Die Markdown Language arbeitet mit harten Zeilenumbrüchen, um Absätze voneinander 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 Tabulatoren oder Leerzeichen darin befinden, ignoriert der Parser diese und interpretiert die Zeile als leer. Möchte man einen Zeilenumbruch im Sinne des <br>-Tags erstellen, fügt man an das Ende einer Zeile zwei Leerzeichen an.

Um einen bestimmten Textbereich als Zitat zu kennzeichnen, können Sie mit Markdown ein sogenanntes Blockquote-Element erzeugen. Hierfür verwenden Sie das Größer-als-Zeichen (>). Sie haben die Möglichkeit, entweder jede einzelne Zeile mit diesem Zeichen zu kennzeichnen oder nur eines an den Anfang des Absatzes zu setzen und den eingerückten Bereich mit einer Leerzeile zu beenden. Im Blockquote-Element sind weitere Formatierungselemente möglich.

Um mit Markdown eine unsortierte Liste zu erstellen, verwenden Sie entweder das Plus-Zeichen, den Bindestrich oder ein Sternchen. Alle drei Varianten werden zum gleichen Ergebnis führen.

Eine sortierte Liste hingegen erzeugt man durch eine Zahl mit einem direkt darauffolgenden Punkt.

Markdown gibt Ihnen zusätzlich die Möglichkeit, Checklisten zu erstellen. Diese erscheinen mit einem Kästchen, das per Knopfdruck 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 Textbereich als Code zu kennzeichnen, nutzt man bei Markdown den sogenannten Backtick, auch als Gravis oder accent grave bekannt – nicht zu verwechseln mit dem einfachen Anführungszeichen. Einen Akzent am Anfang und einen am Ende des entsprechenden Textbereiches erstellt die Markierung. Auf diese Weise lassen sich Quellcode oder Software-Befehle direkt in den Fließtext eingliedern.

Sollte in Ihrem Codebeispiel selbst der Backtick vorkommen, können Sie zu Anfang des Codeabschnitts 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 Leerzeichen verwenden – und zwar für jede Zeile. Um ausgewählte Zeilen noch weiter einrücken zu lassen, fügen Sie einfach weitere Tabulatoren oder Leerzeichen hinzu.

Wer lieber Zeichen zum Einleiten und Beenden von Code-Blöcken verwendet, kann den entsprechenden Bereich auch mit je drei Backticks am Anfang und am Ende markieren. Hier haben Sie zusätzlich – jedenfalls bei vielen Markdown-Editoren – die Möglichkeit, farbige Hervorhebungen automatisch zu erstellen. Hierfür geben Sie nach den drei einleitenden Backticks die Sprache an, in der der darauffolgende Quellcode verfasst wurde.

Mit Markdown können Sie auch Bilder und Hyperlinks in Ihren Text integrieren. Beides entsteht durch eine Kombination 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 optionalen Titel versehen, den der Nutzer sieht, wenn er mit dem Mauszeiger darüberfährt, ist auch dies möglich: Der Text kommt mit in die runden Klammern, von der URL mit einem Leerzeichen getrennt und in doppelte Anführungszeichen gesetzt.

Wenn Sie eine URL oder eine E-Mail-Adresse in den normalen Fließtext einfügen, werden die meisten Markdown-Editoren automatisch einen klickbaren 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 verhindern, markieren Sie die URL als Code und nutzen dafür erneut Backticks.

Ähnlich wie Hyperlinks lassen sich auch Bilder in das Markdown-Dokument einfügen. Hier beginnt man allerdings mit einem Ausrufezeichen. Im Anschluss kommen wieder eckige Klammern zum Einsatz, in denen sich der alternative Text zum Bild befindet, und runde Klammern mit der URL zum Bild. Dieses wird anschließend direkt im Text dargestellt.

Bilder und Hyperlinks lassen sich auch kombinieren. Wenn Sie hinter das Bild einen klickbaren Link setzen möchten, verschachteln Sie die beiden Funktionen miteinander. 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 Kopfzeilen zu erzeugen, die sich optisch vom restlichen Inhalt absetzen, unterstreicht man die entsprechenden Zellen mit Bindestrichen.

Es ist prinzipiell nicht wichtig, dass die Pipes untereinander sind. Dies erhöht nur die Lesbarkeit, wenn das Markdown-Dokument in seiner Rohfassung angesehen wird. Gleiches gilt für die Pipes, die an den Seiten zu finden sind. Auch diese sind für das Kompilieren unerheblich.

Markdown gibt Ihnen die Möglichkeit, Fußnoten zu setzen. In den Fließtext schreiben Sie eine Anmerkungsziffer und lösen diese am Ende der Seite in der Fußnote auf – eine entsprechende Linie wird dabei automatisch erzeugt. Die Anmerkungsziffer ist zudem als Hyperlink formatiert, sodass man bei einem Klick darauf direkt zur entsprechenden Fußnote gelangt. Um diese automatische Funktion nutzen zu können, setzen Sie zuerst die Anmerkungsziffer hinter das gewünschte Wort: In eckigen Klammern schreibt man erst ein Zirkumflex und dann die Nummer.

Welche Nummer (auch andere Begriffe sind möglich) Sie einsetzen, ist unerheblich. Wie beim Erstellen von Listen übernimmt Markdown die Zählung automatisch für Sie. Wichtig ist allerdings, dass Sie die gewählte Bezeichnung auch wieder korrekt auflösen. Dafür setzen Sie die gleiche Ziffer in einer neuen Zeile wieder mit Zirkumflex in eine Klammer, fügen einen Doppelpunkt hinzu und schreiben dann die eigentliche Anmerkung. Diese kann zusätzlich umfassend formatiert werden und sich auch über mehrere Zeilen erstrecken.

Da Markdown eng verwandt mit HTML ist, bedürfen das kaufmännische Und- sowie Kleiner- und Größerzeichen einen besonderen 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 ursprünglichen Bedeutung verwenden, muss man diese in HTML maskieren: &amp;, &lt; und &gt;. Prinzipiell gibt es in Markdown keinen Grund, warum man die Zeichen nicht „wie sie sind“ einsetzen kann. Da Nutzer aber die Möglichkeit haben, Markdown mit HTML zu vermischen, wird der Fall komplexer. Damit Sie nicht selbst diese Schwierigkeit lösen müssen, versteht der Parser, wann Sie die einfachen Schriftzeichen haben möchten und wann Sie HTML-Code verwenden.

Neben den spezifischen Zeichen, die HTML mit sich bringt, nutzt eben auch Markdown bestimmte Symbole zur Auszeichnung. Setzt man diese ein, reagiert der Parser beim Konvertieren darauf. Folgende Zeichen kommen hierfür in Frage:

• Asterisk: *
• Bindestrich:
• Unterstrich: _
• Runde Klammern: ()
• Eckige Klammern: []
• Geschweifte Klammern: {}
• Punkt: .
• Ausrufezeichen: !
• Raute: #
• Gravis: `
• Backslash: \

Um diese Zeichen in ihrer eigentlichen Bedeutung zu verwenden, setzt man einfach jeweils einen Backslash davor. Wichtig: Der Backslash muss vor jedes einzelne Zeichen geschrieben werden; also beispielsweise sowohl vor eine öffnende als auch vor eine schließende Klammer.