Markdoc

Markdoc ist auf die Verwaltung technischer Dokumentation ausgerichtet, kann aber für eine Reihe von Zwecken verwendet werden. Markdoc hat ein paar bemerkenswerte Verkaufsargumente:
* Wikis sind völlig von Klartext-Dateien vorgenommen, so können Sie leicht sie unter Versionskontrolle.
* Wikis kompilieren in eigenständige HTML-Verzeichnisse, die als Tarball von einem HTTP-Server verteilt oder bedient werden kann.
* Sie können wahlweise statische Medien, die in den HTML-Verzeichnis zusammen mit allen Ihren gerenderten Seiten zusammengestellt werden.
* Markdoc kommt mit einem voll funktions pure-Python WSGI Anwendung und HTTP-Server für die Zustellung bis zusammengestellt Wikis.
* Sie können Ihre Wiki, mit einer Vielzahl von Markdown-Erweiterungen wie Pygments-basierten Code-Highlighting, erweiterte Syntax für die Definitionslisten, TOC Generation und so weiter zu machen.
* Sie können komplett gestalten, wie Ihr Wiki ist, indem Sie die verwendet werden, um wiedergegeben Markdown in voller HTML-Dokumente zu konvertieren Jinja2 Vorlagen gerendert.
Quickstart
Installation:
#! / Bin / bash
hg clone ssh: //hg@bitbucket.org/zacharyvoase/markdoc
cd markdoc /
pip -r ANFORDERUNGEN installieren
python setup.py install
Einen Wiki
#! / Bin / bash
markdoc init my-Wiki
cd my-wiki /
vim wiki / somefile.md
# ... Schreiben eine Dokumentation ...
markdoc build
markdoc dienen
# .. Offen http: // localhost: 8008 / in einem Browser ...
Layout
Markdoc Wikis haben folgende Standard-Layout:
WIKI_ROOT /
| - .html /
| - .templates /
| - TMP /
| - Statische /
| - Wiki /
`- Markdoc.yaml
Die .html / TMP und / Verzeichnisse sollten von jeder VCS ausgeschlossen werden, da sie temporäre Dateien enthalten.
Wenden Sie sich an das Layout der Dokumentation in doc / wiki / layout.md für weitere Informationen über die Rollen der verschiedenen Unterverzeichnisse

Anforderungen .

• Python
• pip
• rsync