Dokumente mit Markdown erstellen

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 (Code bei Github).

Für das Schreiben verwende ich in der Regel den Editor Sublime Text. Zusätzlich ist auf meinem System das SublimeText-Paket MarkdownEditing installiert. Damit die Installation von Paketen 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. Selbstverständlich kann auch ein herkömmlicher Text-Editor verwendet werden, aber ein Programm, das auf die Verwendung von Markdown ausgelegt ist (oder eine entsprechende Erweiterung bietet), macht die Sache deutlich einfacher.

Nutzern von macOS sei iA Writer, Byword oder Ulysses ans Herz gelegt. Darüber hinaus gibt es für macOS die App Marked 2. Dabei handelt es sich nicht um einen Editor, sondern ein Programm, das eine Vorschau auf das erstellte Markdown-Dokument gewährt. Außerdem sind bei Marked 2 einige Exportmöglichkeiten mit an Bord.

Aber was ist Markdown eigentlich?

Es handelt sich um eine von John Gruber – unterstützt von Aaron Swartz – entwickelte Auszeichnungssprache. 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. 

- [ ] Notiz 1
- [ ] Notiz 2
- [x] Notiz 3

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.

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 die bereits erwähnte App Marked 2. So werden alle Dokumente, unabhängig vom Editor, immer mit der gleichen Syntax konvertiert. Außerdem bietet Marked 2 für den Export zahlreiche Vorlagen an.

Linux- und Windows-Nutzer hatten es früher nicht ganz so komfortabel; sie mussten die Konvertierung per Terminal bzw. Eingabeaufforderung vornehmen. Mittlerweile gibt es aber auch auf diesen Systemen Editoren, die Markdown-Unterstützung bieten. Erwähnen möchte ich hier Microsofts kostenlosen Editor Visual Studio Code. Um ihn für Markdown verwenden zu können müsst Ihr zusätzlich die Erweiterung Markdown All in One installieren.

Seit kurzer Zeit kann Markdown auch in Google Docs verwendet werden. Wie Ihr dort die Markdown-Unterstützung aktiviert, wird in diesem Blogbeitrag erklärt.

Und wo bekomme ich Pandoc her?

Falls Ihr Pandoc verwenden möchtet, sei auf diese Internetseite verwiesen. Dort kann dieses Programm heruntergeladen werden. Außerdem finden sich dort zahlreiche Beispiele. Wenn Ihr einen Blick darauf werft, werdet Ihr feststellen, dass mit Pandoc Dateien in verschiedenste Formaten konvertiert werden können. Selbst wenn Ihr also Markdown nicht nutzen möchtet, bietet es sich dennoch an, einen Blick auf Pandoc zu werfen.

Ü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 Links und probiert es gleich einmal aus.