MkDocs

MkDocs ist ein freier (BSD-Lizenz), schneller, in Python geschriebener Generator für statische Seiten. MkDocs wurde vor allem im Hinblick auf Projekt-Dokumentationen entwickelt. Die Quellen für die statischen Seiten werden in Markdown-Dateien geschrieben, die Konfiguration erfolgt in einer einzigen YAML-Konfigurations-Datei. Das Ergebnis wird nach HTML herausgeschrieben.

Per Default werden einige Themes (Templates) mitgeliefert, man kann sich aber auch eigene schreiben.

MkDocs kommt mit einem eigenen Entwicklungsserver mit Live-Preview. Als Markdown-Engine kommt Python Markdown zum Einsatz, als Erweiterung werden Tabellen und fenced code blocks und mehr (zum Beispiel Fußnoten) unterstützt.

Tutorial

• Building Product Documentation with MkDocs

Video-Tutorial: Documenting your project with MkDocs

Links

• MkDocs Home
• MkDocs @ GitHub
• grunt-mkdocs ist ein freies (MIT-Lizenz) Grunt-Plugin für MkDocs

---

Sie sind hier: Start → Webworking → Statische Seiten → mkdocs.txt