Neue Bibliothek MarkDown

Wie dokumentiert man sein Projekt möglichst einfach. Eine einfache Art bietet hier die Sprache MarkDown.

Markdown ist eine vereinfachte Auszeichnungssprache, die von John Gruber und Aaron Swartz entworfen wurde. Ein Ziel von Markdown ist, dass schon die Ausgangsform ohne weitere Konvertierung leicht lesbar ist. Als Auszeichnungselemente wurden daher vor allem Auszeichnungsarten verwendet, die in Plaintext und E-Mails üblich sind.
Quelle: http://de.wikipedia.org/wiki/Markdown

Damit die Dokumentation versioniert und passend zum restlichen Quellcode abgelegt werden kann, sollte sie ebenfalls im Versionsverwaltungssystem eingecheckt werden. Da die MarkDown-Dateien auf Text basieren, sind sogar parallele Änderungen möglich.

Da die Syntax für Nicht-Entwickler ggf. etwas schwer zu lesen ist, sollten die MarkDown in PDFs oder HTML-Dateien umgewandelt werden. Diese MarkDown-Bibliothek kann in einem angegeben Verzeichnis alle MarkDown in dieses lesbare Format überführen.

Ebenfalls lässt sich diese Bibliothek in den Build-Prozess integrieren, so dass die Dokumentation immer aktuell ist.

MarkDown im Jenkins

MarkDown im Jenkins

Die Bibliothek findet sich unter meinem GitHub-Account unter https://github.com/denisw160/MarkDown. Die Version habe ich als „MarkDown 0.3“ markiert.

Schreibe einen Kommentar