mkdocs

MkDocs

Projektdokumentation mit Markdown

MkDocs ist ein schneller , einfacher und geradezu großartiger statischer Site-Generator, der auf die Erstellung von Projektdokumentationen ausgerichtet ist. Dokumentationsquelldateien werden in Markdown geschrieben und mit einer einzigen YAML-Konfigurationsdatei konfiguriert. Es ist benutzerfreundlich gestaltet und kann mit Themes, Plugins und Markdown-Erweiterungen von Drittanbietern erweitert werden.

In der Dokumentation finden Sie ein Einführungstutorial und ein vollständiges Benutzerhandbuch.

Merkmale

• Erstellen Sie statische HTML-Dateien aus Markdown-Dateien.
• Verwenden Sie Plugins und Markdown-Erweiterungen, um MkDocs zu verbessern.
• Verwenden Sie die integrierten Themes, Themes von Drittanbietern oder erstellen Sie Ihre eigenen.
• Veröffentlichen Sie Ihre Dokumentation überall dort, wo statische Dateien bereitgestellt werden können.
• Viel mehr!

Unterstützung

Wenn Sie Hilfe bei MkDocs benötigen, zögern Sie nicht, Kontakt mit uns aufzunehmen!

• Für Fragen und hochrangige Diskussionen nutzen Sie Diskussionen auf GitHub.
  • Für kleine Fragen ist der Chatroom auf Gitter/Matrix eine gute Alternative.
• Um einen Fehler zu melden oder eine Funktionsanfrage zu stellen, öffnen Sie ein Problem auf GitHub.

Bitte beachten Sie, dass wir möglicherweise nur Support bei Problemen/Fragen zu Kernfunktionen von MkDocs leisten. Alle Fragen oder Fehlerberichte zu Funktionen von Themes, Plugins, Erweiterungen oder Ähnlichem von Drittanbietern sollten an die jeweiligen Projekte gerichtet werden.
Solche Fragen sind jedoch nicht aus dem Chatroom verbannt.

Bleiben Sie auch hier, um einige Fragen zu beantworten!

Links

• Offizielle Dokumentation
• Aktuelle Versionshinweise
• Katalog mit Plugins, Themes und Rezepten von Drittanbietern

Beitrag zu MkDocs

Das MkDocs-Projekt begrüßt Beiträge von Entwicklern und Benutzern in der Open-Source-Community und ist auf diese angewiesen. Informationen darüber, wie Sie helfen können, finden Sie im Beitragsleitfaden.

Verhaltenskodex

Von jedem, der in den Codebasen, Issue-Trackern und Diskussionsforen des MkDocs-Projekts interagiert, wird erwartet, dass er den PyPA-Verhaltenskodex befolgt.

Lizenz

BSD-2-Klausel