node.jsVor einiger Zeit hatte ich im Beitrag  Markdown for the win über die Vorteile von Markdown geschrieben. Davon bin ich mittlerweile noch überzeugter, als dies damals schon der Fall war. In meiner täglichen Arbeit muss ich laufend Ideen und Überlegungen zu Papier bringen digitalisieren. Bei den meisten üblich ist hier die Verwendung von Microsoft Word, OpenOffice, LibreOffice oder wie sie alle heißen, die Pakete für das Office. Aber das geht auch anders. Hier meine Lösung, die meine (speziellen) Anforderungen zum aktuellen Zeitpunkt vollständig erfüllt.

Anforderungen

Meine Anforderungen sind nicht vielfältig:

  • Schreiben von Dokumenten mittels Markdown Markup – ich möchte nicht auf jedem System ein vollständiges Office-Paket installiert haben, sondern über unterschiedlichste Devices hinweg an meinen Dokumenten schreiben können.
  • Hosting auf einem Webserver (Konvertierung in andere Formate sollte möglich sein)
  • Anpassungen an einem Dokument sollen sofort zur Verfügung gestellt werden
  • Verteilen auf ein für potentielle Leser zugängiges System
  • Einrichtung und Wartung des Systems sollte einen möglichst geringen Aufwand erzeugen.

Was braucht die Lösung?

Eigentlich nicht viel:

Hinweis: Meine Erweiterungen umfassen einige Bugfixes, damit this-blog auch unter Windows korrekt laufen kann. Zusätzlich wurde ein Filewatcher eingebaut, damit Änderungen an Markdown-Dateien sofort wirksam werden (sofern entsprechend konfiguriert).

this-blog ist ein einfaches Blog-System, welches Markdown-Dateien direkt über den Server rendert. Unterstützt wird neben einer lokalen Instanz auch eine remote Instanz inkl. Publishing. Neben Tags, Menüs zur Einfächerung von Posts wird bereits ein nettes Template für ein Blog mitgeliefert, welches entsprechend angepasst werden kann.

Wie funktioniert es?

In meiner eingerichteten Umgebung kommen zwei Instanzen (mit meinen Erweiterungen) zum Einsatz. Für die lokale Instanz ist ein Filewatcher am Laufen. Wird eine Markdown-Datei geändert, zeigt sich diese Änderung nach einem Refresh der Webseite. Nach Fertigstellung des Dokumentes erfolgt ein Publishing auf ein entferntes System inkl. Übermittlung des Links zum Dokumenten an den gewollten Personenkreis.

Diese Aufteilung ist deshalb notwendig, damit keine unnötigen Zwischenstände zu den jeweiligen Personen gelangen. Eine sofortige Aktualisierung im "lokalen” Umfeld ist aber gerade bei notwendigen Abstimmungen innerhalb des Teams etc. sehr hilfreich.

Für den Zugriff auf die Markdown-Dateien bieten sich zahlreiche Möglichkeiten an, um diese überall beschreiben zu können. Angefangen von einem Repository bis hin zu “Cloud”-Verzeichnissen ist grundsätzlich alles möglich.

Und es reicht ein stinknormaler Editor … die Welt kann so einfach sein.

So sieht es aus

Übersicht der einzelnen Dokumente inklusive Einsortierung in Abgeschlossen und In Arbeit.

Einfacher Store für Konzepte, Dokumentationen in der Übersicht

Und hier das Dokument in seiner Gesamtansicht:

Gesamtes Dokument gehostet von node.js, geschrieben mit Markdown

Anpassungen für eine andere Ansicht, einer besseren Auflistung beispielsweise, sind natürlich möglich und einfach zu erledigen.

Fazit

Nicht immer muss ein Office-Paket, eventuell gekoppelt mit einer Sharepoint Document Library, oder einem beliebigen DMS zum Einsatz kommen. In vielen Fällen reicht auch eine einfachere Variante, die zudem einfach synchronisiert und gewartet bzw. auch versioniert werden kann. Alleine zum Schreiben muss kaum etwas installiert werden (maximal ein Client für die Synchronisation von Dateien, wenn beispielsweise Dropbox oder Skydrive verwendet wird). Und in den meisten Fällen reicht der Output vollkommen.

Über den Autor

Norbert Eder

Ich bin ein leidenschaftlicher Softwareentwickler und Fotograf. Mein Wissen und meine Gedanken teile ich nicht nur hier im Blog, sondern auch in Fachartikeln und Büchern.