Markdown über Firefox verwalten

Markdown ist eine Beschreibungssprache, mittels der sich wunderbar Notizen und Dokumentationen festhalten lassen. Markdown-Dateien ähneln stark Klartext und können mit einem einfachen Texteditor bearbeitet werden. Um diese verschiedenen Dateien möglichst leicht verwalten zu können, gibt es kleine Hilfsmittel.

Verzeichnisstruktur

Es bietet sich an, die Dateien in sprechender Form zu verwalten. Das heißt, dass der Datei- und auch der Verzeichnisname einen nachvollziehbaren Hinweis auf den Inhalt geben. Die Datei-Endung sollte “.md” lauten, da viele Tools und Helferlein diese Endung voraussetzen.

Firefox-Plugin

Liegen die Markdown-Dateien in einem Verzeichnis auf der Festplatte, können diese natürlich direkt mittels less angesehen oder mit grep Volltext durchsucht werden. Geht es aber um das Formvollendete Anzeigen der Dateien, greift ein praktisches Firefox-Plugin unter die Arme. Der Markdown-Viewer von Keith L. Robertson ist hier zu empfehlen. Erweitert man sein System um den entsprechenden Mime-Type kann man sich ganz bequem seine aufgewerteten Markdown-Dokumente ansehen; die Index-Funktion des Browsers ermöglicht das Navigieren dabei ungemein.

mkkdir -p ~/.local/share/mime/packages
vim ~/.local/share/mime/packages/text-markdown.xml
<?xml version="1.0"?>
<mime-info xmlns='http://www.freedesktop.org/standards/shared-mime-info'>
  <mime-type type="text/plain">
    <glob pattern="*.md"/>
    <glob pattern="*.mkd"/>
    <glob pattern="*.mkdn"/>
    <glob pattern="*.mdwn"/>
    <glob pattern="*.mdown"/>
    <glob pattern="*.markdown"/>
  </mime-type>
</mime-info>

Im Anschluss muss de Mime-Datenbank noch die Änderung mitgeteilt werden.

update-mime-database ~/.local/share/mime

Nun kann mit Firefox direkt in den aufgehübschten Dokumenten gestöbert werden. Markdown im Firefox …jenachdem, wo die Dateien liegen, sollte natürlich der Pfad angepasst werden. Wenn man es ganz bequem mag, bietet sich dsa Erstellen eines Lesezeichens im Browser an.

Git

Kaum eine gute Verwaltung ohne Versionierung. Diese lässt sin in diesem Fall recht bequem mit Git umsetzten. Erstellt man ein Git-Repository im Verzeichnis der Dokumente, kann jede Änderung festgehalten werden.

git init

Verwendet man mehrere Systeme, ist es durchaus anzuraten ein zentrales Git zu pflegen.

Pandoc

In den meisten Linux-Distributionen und unter FreeBSD ist Pandoc im Software-Repository zu finden.

sudo pkg install hs-pandoc

Erstellt man auf die folgende Art eine HTML-Datei, gewinnt das Ergebnis sicher keinen Schönheitspreis, aber es erfüllt seinen Zweck.

pandoc -o dokument.html dokument.md

So sieht es dann aber schon sehr viel besser aus:

pandoc -s --highlight-style kate -o dokument.html dokument.md

Ja genau, “Syntax-Highlighting”!!!

Welche Stile es gibt kann man wie folgt erfragen:

pandoc --list-highlight-styles
pygments
tango
espresso
zenburn
kate
monochrome
breezedark
haddock

Rsync

Wenn man seine Markdown-Dokumente nun bereits im HTML-Format vorliegen hat, dann drängt es sich ja shcon fast auf, dass man diese über einen Webserver ausgibt. Es handelt sich um statische Dokumente es gibt keine weiteren Abhängigkeiten.

Rsync lässt sich für diesen Zweck gut verwenden, da die Dokumente einfach nur noch kopiert werden müssen; sie sind dann sofort verfügbar.

rsync -avhrz --progress --delete html/* -e ssh NUTZER@SERVER:/var/www/.../

Grundsätzlich sollte man zuvor rsync so konfigurieren, dass es auf die eigenen Bedürfnisse passt, aber das Prinzip sollte durch das Beispiel verdeutlicht werden.