Ansprechende Online-Dokumentationen mit MkDocs erstellen

MkDocs unterstützt Softwareentwickler und Administratoren beim Dokumentieren und kümmert sich darum, dass die Inhalte ansprechend präsentiert werden.

Lesezeit: 6 Min.
In Pocket speichern
vorlesen Druckansicht Kommentare lesen 8 Beiträge

(Bild: Rudolf A. Blaha)

Von
  • Jan Mahn
Inhaltsverzeichnis

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.

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.

MkDocs-Dokumentationen begegnet man recht häufig, sowohl bei der Dokumentation von Open-Source-, als auch bei kommerzieller Software. Nicht immer erkennt man sie auf den ersten Blick – je nach verwendetem Theme sehen die Ergebnisse sehr unterschiedlich aus. Gluster und Trafik.io sind Beispiele von größeren Softwareprojekten. Viele nutzen das Material-Theme, das Googles Designsprache Material umsetzt. Unter den MkDocs-Themes ist es das mit Abstand ausgereifteste und sehr gut personalisierbar.

Immer mehr Wissen. Das digitale Abo für IT und Technik.

  • Zugriff auf alle Inhalte von heise+
  • exklusive Tests, Ratgeber & Hintergründe: unabhängig, kritisch fundiert
  • c't, iX, Technology Review, Mac & i, Make, c't Fotografie direkt im Browser lesen
  • einmal anmelden – auf allen Geräten lesen - monatlich kündbar
  • erster Monat gratis, danach monatlich 9,95 €
  • Wöchentlicher Newsletter mit persönlichen Leseempfehlungen des Chefredakteurs
GRATIS-Monat beginnen Jetzt GRATIS-Monat beginnen Mehr Informationen zu heise+