c't 18/2020
S. 160
Praxis
Dokumentationen mit MkDocs
Bild: Rudolf A. Blaha

Doku-Freuden

Ansprechende Online-Dokumentationen mit MkDocs

MkDocs unterstützt Software­entwickler und Administratoren beim Dokumentieren und kümmert sich darum, dass die Inhalte ansprechend präsentiert werden. Das erhöht die Motivation, Inhalte zu verfassen – und sie zu lesen.

Von Jan Mahn

Eine gute Dokumentation ist mehr als nur lästiges Beiwerk. Administratoren sollten das Wissen über ihr Netzwerk für Kollegen und die Nachwelt festhalten und Softwareentwickler tun ihren Kunden einen großen Gefallen, wenn sie – am besten auf einer stets aktualisierten Website – eine ausführliche Dokumentation anbieten. Und selbst fürs Heimnetz, fürs Smart Home und die Bastelprojekte lohnt ein solches Handbuch.

Schön auf Knopfdruck

Die Software MkDocs gehört zur Gruppe der statischen Seitengeneratoren – ein Schritt zurück zu den Ursprüngen des World Wide Webs. Autoren verfassen die Texte in einer leicht zu lernenden Auszeichnungssprache, in diesem Fall Markdown. MkDocs rendert aus diesen Texten und einer Vorlage fertige HTML-Seiten mit Menü, die man auf einem Webserver ausliefert.

Kommentieren