Zum Inhalt

MkDocs

MkDocs ist eine in Python geschriebenes Programm, mit dem man aus Textdateien eine Website generieren lassen kann. MkDocs wird häufig genutzt, um Online-Dokumentationen zu erstellen. Diese Website hier wird ebenfalls mit MkDocs erzeugt.

Installation

MkDocs benötigt Python und pip, das Standard-Paketinstallationstool von Python.

pip install MkDocs

Grundsätzliches Vorgehen

mkdocs new testprojekt
cd testprojekt
mkdocs serve
  • mit mkdocs new projektname wird ein neues Projekt angelegt - es entsteht ein neues Verzeichnis testprojekt
  • man wechselt in das Verzeichnis
  • mit dem Kommando mkdocs serve wird ein lokaler Webserver gestartet (auf http://localhost:8000)
  • über diesen kann man in einem Browserfenster jeweils aktuell den Inhalt der eigenen Dokumentationswebsite sehen - MkDocs aktualisiert bei jedem Speichern einer Datei sofort die Website

Website generieren

Möchte man zu einem gewissen Datenstand aus den Textdateien eine Web-Version erzeugen, kann man das mit dem Kommando mkdocs build machen. Dann wird ein Unterzeichnis site angelegt und in diesem die statischen HTML-Dateien erzeugt. Diese kann man dann auf einem Webserver ablegen.

Zusätzliche Pakete

Zusätzlich installiere ich in allen meinen MkDocs-Projekten immer noch die folgenden beiden Pakete:

  • Material for MkDocs ist ein modernens und mächtiges Theme mit vielen eingebauten Funktionen, das sich sehr gut für Dokumentations-Websites eignet
  • mkdocs-macros ist ein Plugin, das Variablen, Makros und Scripting innerhalb von MkDocs bereitstellt

Installation

pip install mkdocs-material
pip install mkdocs-macros-plugin

Informationen

Feedback / Kontakt

Wenn Sie Fragen oder Anregungen zum Artikel MkDocs haben, senden Sie mir bitte eine E-Mail an: misc+mkdocs@technotes.jakoubek.net