Markdoc

Markdoc ist hervorragend für technische Dokumentation, Handbücher, interne Projekt Wikis, oder statische Website Generationen.
Für Technische Dokumentation / Handbücher können Markdoc verwendet, um zu schreiben und machen handschriftliche Leitfäden und Handbücher für die Software werden. Diese Unterlagen werden in der Regel getrennt sein von automatisch generierten API-Dokumentation und vielleicht eine übergeordnete Ansicht als alleine API-Dokumentation zu geben. Es könnte für die Client-Dokumentation für Web / Desktop-Anwendungen oder sogar Entwicklerdokumentation für Gerüste verwendet werden.
Für interne Projekt Wikis, Markdoc Wikis bestehen aus einem einzelnen Klartextdatei pro Seite. Durch die Kombination von ein Wiki mit einem DVCS (wie Mercurial oder Git), können Sie mit mehreren anderen Personen zusammenarbeiten können. Verwenden Sie die DVCS zu verfolgen, teilen und zusammenführen Änderungen untereinander, und zeigen Sie die Wiki & rsquo; s Geschichte.
Für statische Website Industrie, wandelt Markdoc Wikis in rohe HTML-Dateien und Medien. Damit können Sie ein Blog, persönliche Website oder eine Sammlung von Seiten in einem Markdoc Wiki, vielleicht mit benutzerdefinierte CSS-Stile zu verwalten und zu veröffentlichen, die gerenderte HTML zu einer Website. Markdoc muss nicht auf dem Hosting-Site installiert werden, da die resultierende HTML ist völlig unabhängig

Eigenschaften .

• Stellen Sie Google Analytics-Tracking in eine Zeile der Konfigurations.
• Barebones Wikis, die genau wie Verzeichnisse mit Markdown-formatierte Textdateien in ihnen zu suchen.
• Eine eingebaute HTTP-Server und WSGI Anwendung zu servieren eine kompilierte Wiki, mit einem einzigen Befehl.
• Continuous Builds (via rsync) bedeuten, der Server läuft, während Markdoc re-kompiliert das Wiki zu halten. Einfach aktualisieren Sie Ihren Browser, um die Änderungen zu sehen.
• In Pygments-powered Syntax-Hervorhebung, um Ihre Markdoc Wiki mit einem einzigen Konfigurationsparameter.
• Markdoc ist Public Domain Software. Es wird immer völlig kostenlos zu benutzen sein, und man kann es (in teilweise oder vollständig) unter keinen Umständen (Open-Source, proprietäre oder anderweitig) ohne Namensnennung oder encumberances verteilen.

Anforderungen :

• argparse
• CherryPy
• Jinja2
• Markdown
• Pygments
• PyYAML
• WebOb
• Python 2.4 oder höher
• rsync