Allgemeine Information zu MkDocs

MkDocs ist ein schneller und einfach zu bedienender Generator für statische Websites, der auf die Erstellung von Projektdokumentationen ausgerichtet ist.
Die Quelldateien der Dokumentation werden in Markdown geschrieben und mit einer einzigen YAML-Konfigurationsdatei konfiguriert.

Die vollständige Dokumentation zu MkDocs ist hier zu finden.

Vielzahl an Themes vorhanden

Das Aussehen von MkDocs kann über eine einzige Config-Zeile verändert werden, es gibt unter anderem die folgenden, integrierten Themes.

Weitere Themes (wie der aktuell genutzte Material-Theme) können über Plugins nachträglich hinzugefügt werden!

Die vollständige Dokumentation zum Material-Theme ist hier zu finden.

Live-Preview

Der eingebaute Dev-Server ermöglicht es die Dokumentation schon während des Schreibens in der Vorschau zu betrachten. Er lädt sogar automatisch neu und aktualisiert den Browser, wenn die Änderungen gespeichert werden.

Einfache Anpassbarkeit

Die Projektdokumentation kann komplett den eigenen Vorstellungen angepasst werden, es sind viele Konfigurationsoptionen verfügbar, alles innerhalb einer einzigen Konfigurationsdatei.

Überall hosten

MkDocs erstellt vollständig statische HTML-Seiten, die auf Github Pages, Gitlab Pages, Amazon S3 oder in einem eigenen Webserver (hier in einem Docker-Container) gehostet werden können.