Werkzeuge

Dieses Kapitel beschreibt die Installation von Pandoc bzw. des originalen Markdown-Konverters. Außerdem stelle ich Ihnen einige Editoren mit Markdown-Unterstützung vor.

Pandoc installieren

Damit Sie Ihre Markdown-Texte in das HTML-Format oder in ein anderes Format umwandeln können, benötigen Sie einen Markdown-Konverter. Ich empfehle Ihnen die Installation von Pandoc, dem zur Zeit vielseitigsten Markdown-Konverter. Alternativ können Sie aber auch das Perl-Script Markdown.pl von John Gruber oder einen anderen Markdown-Konverter installieren.

Hinweis

Es gibt einige Editoren, die einen Markdown-Konverter gleich mitbringen. Für erste Experimente ist das durchaus bequem. Allerdings legen Sie sich damit auf die vom jeweiligen Editor unterstützte Markdown-Variante fest, die weniger Funktionen bietet als Pandoc.

Pandoc unter Windows installieren

Pandoc steht auf der folgenden GitHub-Seite zum kostenlosen Download als MSI-Datei bereit:

https://github.com/jgm/pandoc/releases

Ein Doppelklick auf die MSI-Datei und eine Bestätigung der Open-Source-Lizenz GPL – mehr ist nicht zu tun, um Pandoc zu installieren. Wenn Sie sich vergewissern möchten, dass alles funktioniert hat, öffnen Sie ein Eingabeaufforderungsfenster und führen dort pandoc -v aus.

Pandoc-Versionsinformationen unter Windows lesen

Pandoc unter Linux installieren

Unter Linux ist die Installation besonders einfach: Die meisten Distributionen liefern standardmäßig entsprechende Pakete mit, die Sie unkompliziert mit dem Paketverwaltungswerkzeugen installieren können. Unter Ubuntu führen Sie beispielsweise einfach apt install pandoc aus.

Wenn Ihre Distribution keine Pandoc-Pakete anbietet oder wenn diese veraltet sind (leider keine Seltenheit), müssen Sie zuerst die exotische Programmiersprache Haskell installieren (unter Ubuntu mit apt install haskell-platform). Haskell verfügt mit dem Kommando cabal über ein eigenes Paketverwaltungssystem. Damit installieren Sie nun die gerade aktuelle Pandoc-Version aus einer Haskell-Paketquelle:

cabal update cabal install pandoc

Pandoc wird nun heruntergeladen und kompiliert. Dieser Prozess nimmt einige Minuten in Anspruch. Sollten dabei Fehler auftreten, stellen Sie sicher, dass alle Pakete Ihrer Linux-Distribution aktuell sind. Unter Ubuntu führen Sie dazu apt update sowie apt full-upgrade aus. Anschließend versuchen Sie es nochmals. Das eigentliche Pandoc-Kommando wird in das Verzeichnis /home/<username>/.cabal/bin installiert. Damit Sie Pandoc ohne Angabe des Pfads direkt aufrufen können, sollten Sie dieses Verzeichnis Ihrer PATH-Umgebungsvariable hinzufügen. Dazu laden Sie die Datei .bashrc in einen Editor und fügen am Ende der Datei die folgende Zeile hinzu:

# am Ende von .bashrc ... export PATH=$PATH:~/.cabal/bin

Nachdem Sie das Terminal geschlossen und neuerlich geöffnet haben, vergewissen Sie sich, dass alles funktioniert hat:

pandoc -v pandoc 2.3 Compiled with pandoc-types 1.17.5.1, ... Default user data directory: /home/kofler/.pandoc Copyright (C) 2006-2018 John MacFarlane

Tipp

Wenn Sie zu einem späteren Zeitpunkt Pandoc auf eine neue Version aktualisieren möchten, wiederholen Sie einfach die beiden oben angegebenen cabal-Kommandos.

Pandoc unter macOS installieren

Ein fertiges Installationspaket für macOS finden Sie auf der Pandoc-Download-Seite. Die Installation verläuft unkompliziert und schnell. Nach der Installation öffnen Sie ein Terminalfenster und führen dort wie unter Linux das Kommando pandoc -v aus. Pandoc zeigt dann die Versionsnummer an.

Pandoc verwenden

Pandoc enthält keine grafische Benutzeroberfläche und ist somit nach der Installation unsichtbar; es gibt kein neues Icon oder Programm im Startmenü. Pandoc wird ausschließlich als Kommando in einem Eingabeaufforderungsfenster (Windows) bzw. in einem Terminal (Linux, macOS) ausgeführt.

Eine kurze Bedienungsanleitung zu Pandoc liefert man pandoc (nur unter Linux und macOS). Eine lange Liste aller Optionen erhalten Sie mit pandoc --help. Im einfachsten Fall, d.h., wenn Sie eine Markdown-Datei in das HTML-Format konvertieren möchten, rufen Sie pandoc so auf:

pandoc -o output.html input.md

Wenn Sie weder die Option -o noch eine Markdown-Datei angeben, liest pandoc die zu verarbeitenden Daten aus der Standardeingabe und schreibt das resultierende HTML-Dokument in die Standardausgabe.

Zum Erzeugen von HTML-Dokumenten ist es meist zweckmäßig, auch die Optionen -s sowie -c name.css zu verwenden. Damit erreichen Sie, dass das HTML-Dokument mit den vom HTML-Standard vorgeschriebenen Headern ausgestattet und die angegebene CSS-Datei eingebunden wird. Einen Überblick über weitere Optionen und andere Anwendungsformen des pandoc-Kommandos gibt das Kapitel Das Pandoc-Kommando.

Original-Markdown installieren

Anstelle von Pandoc können Sie auch das Perl-Script Markdown.pl von John Gruber oder einen anderen Markdown-Konverter installieren. Markdown.pl ist in einem kleinen ZIP-Archiv enthalten, das Sie von der Website Daring Fireball herunterladen.

Hinweis

Zur Ausführung von Markdown.pl benötigen Sie die Programmiersprache Perl. Der Perl-Interpreter steht unter Linux und macOS standardmäßig zur Verfügung. Sollten Sie unter Windows arbeiten, müssen Sie Perl selbst installieren. Download-Links finden Sie hier.

Nach dem Download von Markdown können Sie mit perldoc Markdown.pl die Bedienungsanleitung lesen. Um die Markdown-Datei input.text zu verarbeiten und daraus output.html zu erzeugen, führen Sie Markdown so aus:

Markdown.pl input.text > output.html

Markdown-Editoren

Grundsätzlich können Sie Markdown-Dokumente mit jedem beliebigen Editor verfassen. Spezielle Markdown-Editoren bzw. -Erweiterungen machen diesen Prozess aber komfortabler, sei es durch Syntax-Highlighting, durch eine Live-Vorschau des Dokuments oder durch integrierte Export-Kommandos.

Diesen Vorteil erkaufen Sie aber in vielen Fällen mit einem wesentlichen Nachteil: Die meisten Markdown-Editoren unterstützen nur einen bestimmten Markdown-Dialekt, dessen Syntax weit weniger reichhaltig ist als bei Pandoc.

Markdown im Webbrowser

Ganz ohne Installation können Sie Markdown in einem Web-basierten Editor ausprobieren und erlernen. Dabei stehen gleich mehrere Angebote zur Auswahl. Empfehlenswert sind die beiden folgenden Seiten:

• https://stackedit.io: StackEdit sieht mit seiner Symbolleiste fast wie ein »echtes« Programm aus (siehe die folgende Abbildung). Es unterstützt einige Markdown-Erweiterungen, z.B. Tabellen, mathematische Formeln und einfache Diagramme.

• https://dillinger.io: Dillinger bietet zwar weniger Funktionen als StackEdit, enthält dafür aber eine praktische eine PDF-Export-Funktion.

SlackEdit – eIn Markdown-Editor im Webbrowser

Editoren für Einsteiger …

In den vergangenen Jahren wurden unzählige Programme vorgestellt, die das Verfassen von Markdown-Texten leichter machen sollten. Langfristig durchsetzen konnte sich bisher jedoch keines dieser Programme. Vielfach ist die Entwicklung nach einem vielversprechenden Start schnell wieder eingeschlafen. Aus Platzgründen nenne ich an dieser Stelle nur einige populäre Vertreter.

• Als bekanntester Markdown-Editor unter Windows gilt vermutlich noch immer MarkdownPad. Seine Bekanntheit verdankt dieses Programm seiner Vorreiterrolle. Ende 2014 wurde die Entwicklung eingestellt.

• Vielversprechend sieht der plattformunabhängige Editor Haroopad aus (siehe die folgende Abbildung). Allerdings stammt der letzte GitHub-Commit auch in diesem Fall aus dem Jahr 2014.

• Unter dem Namen Typora steht aktuell ein kommerzieller Editor für die Plattformen Windows, macos und Linux in Entwicklung. Als ich dieses E-Book verfasste, befand sich das Programm noch im Beta-Test und war kostenlos verfügbar.

• Nur unter macOS ist das kommerzielle Programm Marked2 verfügbar. Anders als der Name vermuten lässt, handelt es sich dabei nicht um einen Editor. Marked überwacht lediglich Markdown-Dateien und erzeugt nach jedem Speichervorgang eine neue Vorschau des aktuellen Dokuments. Dieser minimalistische Ansatz erweitert jeden Texteditor um eine Markdown-Vorschau.

• Unter Linux können die Standardeditoren Gedit und KWrite zumindest rudimentär Markdown-Syntaxelemente hervorheben.

Haroopad bietet viele Einstellmöglichkeiten und steht für Windows, Linux und macOS zur Verfügung.

… und für Profis

Entwicklern und fortgeschrittenen Anwendern empfehle ich, ganz einfach bei ihren Lieblings-Editoren zu bleiben. Für nahezu alle gängigen Editoren, z.B. für Atom und VSCode, aber auch für »Urgesteine« wie Emacs oder Vi (vim) gibt es Markdown-Erweitungen. Deren Installation ist in der Regel nicht schwierig.

Wenn Sie mit keinem dieser Editoren vertraut sind, sollten Sie sich die Mühe machen, einen derartigen Editor zu erlernen. Das kostet zugegebermaßen anfangs Zeit, lohnt sich...