Nach einiger Recherche habe ich nun meinen Dokumentationsstandard gefunden. Zu lösen war die Konstellation.
- 2 Blogs
- SVN Server
- Git Repositories
In diesen Bereichen werden je nach Bedarf Dokumente erstellt. Wichtig war ein einheitliches Format um bei Bedarf zum Beispiel auch bestehende, noch nicht veröffentlichte Beiträge auf einfache Weise zu publizieren. Ebenfalls wichtig war eine einfache Auszeichnungssprache, um auch mobil am iPad (wo auch gerade dieser Post entsteht) arbeiten zu können ohne in anglebrackets <> zu versinken.
Tools
Folgende Tools kommen zum Einsatz.
- 1Writer (4.99 €; App-Store-Link)
- Atom (kostenlos; GitHub)
- Atom markdown-preview (kostenlos; GitHub)
- WordPress Markdown-Plugin (kostenlos; Jetpack-Link)
- Markdown Preview Plus (kostenlos; Chrome-Extensions-Link)
- Apache2 (kostenlos; Link)
- Git (kostenlos; Link)
- SourceTree (kostenlos; Link)
- Dropbox (kostenlos; Link)
Workflow
Geschrieben wird der Content entweder in Atom (Mac/Windows) oder in 1Writer (iPad). Beide Programme besitzen ein Preview Feature (Atom Shortcut shift+ctrl+m). Im iPad-UseCase wird das Dokument in einen dedizierten Markdown-Ordner über Dropbox synchronisiert. Von dort kann die Datei auf dem Rechner in das entsprechende Git Repository aufgenommen werden. Für das einfache Arbeiten mit Git verwende ich SourceTree.
Soll der Artikel auf einem der Weblogs veröffentlicht werden wird der Text in den WordPress Text-Editor (nicht Visual) kopiert. Nach der Veröffentlichung erzeugt WordPress mit Hilfe des Markdown-Plugins den entsprechenden HTML-Code.
Im Falle von privaten Dokumenten wird der Inhalt über einen Apache, welcher auf meinem lokalen Raspberry Pi läuft, im lokalen Netz veröffentlicht. Die .md Dokumente werden beim Aufrufen im Chrome mit Hilfe von Markdown Preview Plus automatisch gerendert. Ein Konvertieren über das Linux Paket markdown in HTML ist zwar möglich, bringt mir jedoch keinen Mehrwert.
Happy Writing!