Markdoc

Markdoc er gearet til at styre teknisk dokumentation, men kan bruges til en række formål. Markdoc har et par bemærkelsesværdige salgsargumenter:
* Wikis består helt af alm filer, så du nemt kan sætte dem under versionskontrol.
* Wikis kompilere i standalone HTML mapper, som kan distribueres som tarballs eller betjenes af en HTTP-server.
* Du kan eventuelt omfatte statiske medier, som vil blive udarbejdet i HTML biblioteket sammen alle dine afsmeltet sider.
* Markdoc kommer med en fuldt funktionel pure-Python WSGI ansøgning og HTTP-server til servering op kompileret wikis.
* Du kan gøre din wiki med en række Markdown extensions, såsom Pygments-baserede kode fremhævning, udvidet syntaks for definition lister, TOC generation, et cetera.
* Du kan helt tilpasse, hvordan din wiki gengives ved at redigere Jinja2 skabeloner der bruges til at konvertere gjort Markdown i fuld HTML-dokumenter.
Quickstart
Installation:
#! / Bin / bash
hg klon ssh: //hg@bitbucket.org/zacharyvoase/markdoc
cd markdoc /
pip installere -R KRAV
python setup.py installere
Gør en Wiki
#! / Bin / bash
markdoc init min-wiki
cd min-wiki /
vim wiki / somefile.md
# ... Skrive noget dokumentation ...
markdoc build
markdoc tjene
# .. Åben http: // localhost: 8008 / i en browser ...
Layout
Markdoc wikis har følgende standard layout:
WIKI_ROOT /
| - .html /
| - .templates /
| - .tmp /
| - Statisk /
| - Wiki /
`- Markdoc.yaml
.html / Og .tmp / mapper bør udelukkes fra enhver VCS, da de indeholder midlertidige filer.
Konsultere layout dokumentation i doc / wiki / layout.md for mere information om de roller, forskellige undermapper

Krav :.

• Python
• pip
• rsync