Markdown

In meiner täglichen Arbeit erstelle ich meistens Markdown-Dokumente, die dann ggf. in HTML, LaTeX, PDF oder ePub umgewandelt werden. Dafür verwende ich entweder die Exportfunktion des jeweiligen Editors (soweit vorhanden) oder das kostenlose Programm Pandoc.

Für das Schreiben verwende ich in der Regel den Editor Sublime Text.[1] Zusätzlich ist auf meinem System das Sublime Text Package MarkdownEditing installiert. Damit die Installation von Packages leichter zur Hand geht, nutze ich Package Control. Mit MarkdownEditing wird die Markdown-Syntax in Sublime Text besonders hervorgehoben, was das editieren erheblich vereinfacht.

Mit Tipps zum “richtigen” (Markdown-)Editor ist das so eine Sache. Nach meiner Ansicht sollte man ausprobieren, welcher Editor am besten zu einem passt. Die Eingabe des Suchbegriffs “Markdown” in den einschlägigen App Stores führt zahlreiche kostenpflichtige und kostenlose Angebote zu Tage.

Nutzern von macOS sei an dieser Stelle aber das Programm Marked 2 ans Herz gelegt, das nicht nur eine Vorschau auf das Dokument gewährt, sondern auch zahlreiche – Exportmöglichkeiten – bietet.

Aber was ist Markdown eigentlich?

Es handelt sich um eine von John Gruber – unterstützt von Aaron Swartz – entwickelte Auszeichnungssprache.[2] Markdown-Dokumente sind letztendlich herkömmliche Textdokumente, wobei die Formatierung über eine besondere Markdown-Syntax erfolgt. Diese Syntax ist dabei bewusst einfach gehalten; hier einige Beispiele:

# Überschrift 1
## Überschrift 2
### Überschrift 3

*kursiv*
**fett**

Aufzählungen:

* erster Punkt
* zweiter Punkt
* etc. 

Eine umfangreiche Übersicht gibt es auf der Internetseite Daring Fireball von John Gruber.

Welche Markdown-Syntax?

Mit der Syntax ist das so eine Sache. Denn abgesehen von der ursprünglichen Original-Syntax existieren mittlerweile zahlreiche Abwandlungen. Sofern Ihr regelmäßig den gleichen Markdown-Editor verwendet, wird Euch das aber vermutlich nicht weiter interessieren. Die Ausgabe des Dokuments erfolgt dann normalerweise auf der Basis der Original-Markdown-Syntax. Das Ergebnis Eurer Arbeit dürfte also stets gleich aussehen.

Wenn Ihr aber ein Konvertierungstool, wie das oben erwähnte Pandoc verwendet, werdet Ihr bereits Abweichungen feststellen, denn Pandoc verwendet eine spezielle Pandoc-Markdown-Syntax.[3]

Unter macOS lässt sich ein Workflow nutzen, bei dem stets das gleiche Ergebnis herauskommt. Dazu schreibt Ihr Euer Markdown-Dokument mit dem Editor Eurer Wahl. Ihr verwendet aber für die Vorschau und Konvertierung nicht den Editor, sondern das Programm Marked 2. In den Einstellungen dieses Programms legt Ihr zuvor fest, dass für die Konvertierung stets Pandoc verwendet werden soll. So werden alle Dokumente, unabhängig vom Editor, immer mit der gleichen Syntax konvertiert. Linux- und Windows-Nutzer haben es nicht ganz so komfortabel; sie müssen die Konvertierung per Terminal bzw. Eingabeaufforderung vornehmen. Mir ist zumindest für diese Betriebssysteme kein mit Marked 2 vergleichbares Programm bekannt.

Und wo bekomme ich Pandoc her?

Zur Antwort auf diese Frage sei auf diese Internetseite verwiesen. Windows– und macOS-Nutzer können sich dort das jeweils erforderliche Installationspaket herunterladen. Auf einem Ubuntu- oder Debian-System reicht es aus im Terminal

$ sudo apt-get install pandoc

auszuführen.

Auf der Internetseite des Pandoc-Entwicklers John MacFarlane erhaltet Ihr zahlreiche Informationen zur Verwendung von Pandoc.

Über Markdown ließe sich noch viel schreiben. Für den Einstieg solltet Ihr nun aber genug Informationen erhalten haben. Besucht doch die im Artikel angegebenen Verweise und probiert es sogleich einmal aus.