Da ich lange meine Snippets auf meinen Websites in Blogs oder in Snippet-Bereichen gelagert habe, war ich kürzlich auf der Suche nach einem neuem Tool. Hier ein Liste der Software, die ich dabei entdeckt habe und im Rahmen der Drupal User Group Ruhr vorgestellt habe:
- Bei Joplin handelt sich um eine Open Source Desktop-App in der sich eure Dokumentation und Schnipsel im Markdown schreiben und exportieren lassen. Alle gängigen Betriebsysteme (Linux, macOS, Windows) werden bedient und es gibt sogar Apps für eurer Mobile Device (iOS und Android). Synchronisieren kann man die Apps mit unterschiedlichen Diensten (u.a. Dropbox und Nextcloud). joplinapp.org
- Grav ist ein Flat-File CMS, das seine Inhalte in Markdown speichert und das damit allein für eine Dokumentation schon gut geeignet ist. Dazu gibt es Themes mit dem ihr eine hervorragende Ausgangsbasis für eure Dokumentation habt. Ein guter Startpunkt, um diese zu verstehen, sind Skeletons, die Beispiel-Inhalte bieten: Learn2 und Learn2 with Git Sync.
- Mein persönlicher Favorit ist aktuell Typemill, obwohl ich weiterhin Joplin für die schnelle Snippet-Ablage für Zwischendurch nutze. Das Flat-File CMS verwaltet ebenso wie Grav seinen Content in Markdown. Es beschreibt sich selbst als Tool für Dokumentationen, Handbücher, Web-Novellen und normale Websites. Es bietet Plugins, die auf diesen Use-Case zugeschnitten sind, u.a. Syntax-Highlightning, EBook-Exporter und Thesaurus. Da ich etwas einen Button vermisst habe, mit dem man Code in die Zwischenablage kopiert, habe ich auf Basis von clipboard.js ein Plugin geschrieben (Work in Progress).
- Nicht getestet habe ich bisher Wiki.js, da es aber ein Hinweis aus der User Group war und ebenfalls OpenSource ist, möchte ich es zumindest erwähnen.
Ein weiteres Tool möchte ich ebenfalls noch kurz erwähnen. Es handelt sich nicht direkt um ein Dokumentationstool, jedoch habe ich es ihm Rahmen meiner Recherchen entdeckt und finde es äußerst nützlich. Es handelt sich um ein Firefox und Chrome Erweiterung. Das Browser-Plugin CodeCopy stellt auf einigen bekannten Diensten und Websites einen Button bereit, mit dem sich auf der Basis von Clipboard.js Code direkt in die Zwischenablage kopieren lässt (u.a. medium.com, Stack Overflow, GitHub, npm...). CodyCopy ist ebenfalls Open Source.