MkDocs: Dokumentationen mit Markdown
MkDocs ist ein freier (BSD-Lizenz), einfacher Static Site Generator, der mit dem Ziel entwickelt wurde, die Erstellung von Projekt-Dokumentationen zu vereinfachen. Alle Quelldateien werden in Markdown geschrieben und die Konfiguration erfolgt mittels einer einzigen YAML-Konfigurations-Datei.
MkDocs ist in Python geschrieben. Als Markdown-Engine kommt Python Markdown zum Einsatz, als Erweiterung werden Tabellen, fenced code blocks und mehr (zum Beispiel Fußnoten) unterstützt.
Die mitgelieferten Templates sind responsive (hinter den Kulissen werkelt Bootstrap). Könnte ich daher auch für meine Experimente verwenden.
Weitere Links
- MkDocs @ GitHub
- Material - A material design theme for MkDocs - GitHub Pages
- Building Product Documentation with MkDocs - SitePoint
- MkDocs in meinem Wiki
Über …
Der Schockwellenreiter ist seit dem 24. April 2000 das Weblog digitale Kritzelheft von Jörg Kantel (Neuköllner, EDV-Leiter, Autor, Netzaktivist und Hundesportler — Reihenfolge rein zufällig). Hier steht, was mir gefällt. Wem es nicht gefällt, der braucht ja nicht mitzulesen. Wer aber mitliest, ist herzlich willkommen und eingeladen, mitzudiskutieren!
Alle eigenen Inhalte des Schockwellenreiters stehen unter einer Creative-Commons-Lizenz, jedoch können fremde Inhalte (speziell Videos, Photos und sonstige Bilder) unter einer anderen Lizenz stehen.
Der Besuch dieser Webseite wird aktuell von der Piwik Webanalyse erfaßt. Hier können Sie der Erfassung widersprechen.
Diese Seite verwendet keine Cookies. Warum auch? Was allerdings die iframes von Amazon, YouTube und Co. machen, entzieht sich meiner Kenntnis.
Werbung
Werbung
