Markdoc

Markdoc er rettet mot styring av teknisk dokumentasjon, men kan brukes til en rekke formål. Markdoc har noen bemerkelsesverdige salgsargumenter:
* Wikier er bygget opp helt fra klartekst filer, slik at du enkelt kan sette dem under versjonskontroll.
* Wikier kompilere inn stående HTML kataloger, som kan distribueres som tarballs eller servert av en HTTP-server.
* Du kan eventuelt inkludere statiske medier som vil bli samlet inn i HTML-katalogen sammen med alle dine utførte sider.
* Markdoc kommer med en fullt funksjonell pure-Python WSGI søknad og HTTP-server for å tjene opp kompilert wikier.
* Du kan gjengi wiki med en rekke Markdown utvidelser, for eksempel Pygments-basert kode utheving, utvidet syntaks for definisjonslister, TOC generasjon, et cetera.
* Du kan helt tilpasse hvordan wiki er gjengitt ved å redigere Jinja2 maler som brukes til å konvertere gjengis Markdown i full HTML-dokumenter.
Hurtigstart
Installasjon:
#! / Bin / bash
hg clone ssh: //hg@bitbucket.org/zacharyvoase/markdoc
cd markdoc /
Pip installere -r KRAV
python setup.py installere
Å gjøre en Wiki
#! / Bin / bash
markdoc init my-wiki
cd my-wiki /
vim wiki / somefile.md
# ... Skrive noen dokumentasjon ...
markdoc build
markdoc tjene
# .. Åpne http: // localhost: 8008 / i en nettleser ...
Layout
Markdoc wikier har følgende standard layout:
WIKI_ROOT /
| - .html /
| - .templates /
| - Tmp /
| - Statisk /
| - Wiki /
`- Markdoc.yaml
.html / Og tmp / kataloger skal utelukkes fra alle VCS, siden de inneholder midlertidige filer.
Se dokumentasjonen layout i doc / wiki / layout.md for mer informasjon om rollene til ulike underkataloger

Krav .

• Python
• pip
• rsync