| MkDocs | |
|---|---|
 | |
| Basisdaten | |
| Entwickler | Tom Christie, Dougal Matthews, Waylan Limberg, Oleh Prypin, Ultrabug |
| Erscheinungsjahr | 2014-01-24 |
| Aktuelle Version | 1.6.1 (30. August 2024) |
| Betriebssystem | Plattformunabhängig |
| Programmiersprache | Python |
| Kategorie | Dokumentengenerator |
| Lizenz | BSD |
| https://www.mkdocs.org | |
MkDocs ist ein Generator für statische Websites, der speziell für die Erstellung von Projektdokumentationen entwickelt wurde. Er ist in Python geschrieben und wird auch in anderen Umgebungen eingesetzt.
MkDocs wandelt Markdown-Dateien in HTML-Seiten um und erstellt so eine statische Website mit Dokumentationen.
Markdown ist erweiterbar, und das MkDocs-Ökosystem nutzt diese Erweiterbarkeit durch eine Reihe von Erweiterungen aus. Diese helfen dabei, Dokumentation aus Quellcode automatisch zu generieren, Hinweise hinzuzufügen, mathematische Notationen zu schreiben, Fußnoten einzufügen, Quellcode hervorzuheben usw.
MkDocs bietet zwei integrierte Designs: das Standarddesign (basierend auf Bootstrap) und das „Read the Docs“-Design. Viele der verfügbaren Designs von Drittanbietern sind im offiziellen Katalog aufgeführt, darunter auch das beliebte „Material for MkDocs“-Design.
Die erste mit einem Tag versehene Version von MkDocs, Version 0.2, erschien am 21. Januar 2014.
Anfang 2015 unterstützte Read the Docs neben Sphinx auch die Erstellung von Dokumentationen mit MkDocs. Im Vorfeld der Version 0.12 begann MkDocs, Read the Docs für das Hosting zu nutzen.
Im Januar 2016 wurde MkDocs um die Unterstützung für installierbare Designs erweitert. Im darauffolgenden Monat begann Martin Donath mit der Entwicklung des Designs „Material for MkDocs“. In den folgenden Jahren erfreute sich das Design großer Beliebtheit, und im Juli 2020 wurde das Entwicklungsmodell auf „Sponsorware“ umgestellt, wobei neue Funktionen zunächst in der „Insiders“-Version veröffentlicht werden und erst nach Erreichen der Finanzierungsziele öffentlich verfügbar sind.
Martin Donaths Projekt entwickelte sich zu einem eigenständigen Projekt (Material for MkDocs)und war fast 10 Jahre lang aktiv. Nachdem es eine Zeit lang inaktiv war, gab Donath bekannt, dass er die Nutzung von MkDocs aufgrund inhärenter Einschränkungen aufgibt, und entwickelte in einem neuen Projekt namens Zensical eine neue statische Engine von Grund auf neu.
Im März 2026, nach einigen Änderungen in der Liste der Betreuer, übernahm die ursprüngliche Entwicklerin von MkDocs (Mia Kimberly Christie – @lovelydinosaur) erneut die Kontrolle über das Repository und kündigte an, dass die Version v2.0 von MkDocs derzeit in Arbeit ist.
MkDocs bietet integrierte Unterstützung für die Bereitstellung auf GitHub Pages. Alternativen wie GitLab und Cloudflare Pages bieten offizielle Unterstützung für die Bereitstellung von MkDocs-Websites.
Viele Unternehmen nutzen MkDocs in Verbindung mit dem „Material“-Theme zur Bereitstellung ihrer Dokumentation, darunter Atlassian, Google, Microsoft, und Red Hat. Auch bei Open-Source-Projekten wie Electron, Kubernetes, und WebKit ist es eine beliebte Wahl.