Markdoc

Markdoc is gerig op die bestuur van tegniese dokumentasie, maar kan gebruik word vir 'n verskeidenheid doeleindes. Markdoc het 'n paar noemenswaardige selling points:
* Wikis is heeltemal gemaak van plat lêers, sodat jy kan hulle maklik onder weergawe beheer.
* Wikis stel in selfstandige HTML dopgehou, wat versprei kan word as tarballs of bedien deur 'n HTTP-bediener.
* Jy kan opsioneel sluit statiese media wat sal saamgestel word in die HTML gids saam al jou gelewer bladsye.
* Markdoc kom met 'n ten volle funksionele suiwer Python WSGI aansoek en HTTP bediener vir diens aan saamgestel wikis.
* Jy kan jou wiki met 'n verskeidenheid van Afprijzingsmanager uitbreidings, soos Pygments-gebaseerde kode beklemtoon, uitgebreide sintaksis vir definisie lyste, TOC geslag, ensovoorts te lewer.
* Jy kan heeltemal aanpas hoe jou wiki gelewer deur die wysiging van die Jinja2 templates gebruik word om dienste Afprijzingsmanager omskep in volle HTML dokumente.
Quick
Installasie:
#! / Bin / bash
HG kloon ssh: //hg@bitbucket.org/zacharyvoase/markdoc
cd markdoc /
PIP installeer r VEREISTES
python setup.py installeer
'N Wiki
#! / Bin / bash
markdoc init my-wiki
cd my-wiki /
vim wiki / somefile.md
# ... Skryf 'n paar dokumentasie ...
markdoc bou
markdoc dien
# .. Oop http: // localhost: 8008 / in 'n leser ...
Layout
Markdoc wikis het die volgende verstek uitleg:
WIKI_ROOT /
| - Html /
| - .templates /
| - Tmp /
| - Statiese /
| - Wiki /
`- Markdoc.yaml
Die Html / en Tmp / dopgehou moet uit enige VCS uitgesluit, aangesien hulle tydelike lêers bevat.
Raadpleeg die uitleg dokumentasie in doc / wiki / layout.md vir meer inligting oor die rolle van die verskillende subdirectories

Vereistes :.

• Python
• pit
• rsync