Markdoc yra orientuota į valdymo techninę dokumentaciją, tačiau gali būti naudojamas įvairioms paskirtims. Markdoc turi keletą pastebimų pardavimo taškų:
* Wiki yra sudaryta tik iš paprastojo failų, todėl jūs galite lengvai juos pagal versijų kontrolę.
* Wiki kaupia į standalone HTML katalogų, kurie gali būti platinami kaip archyvų ar aptarnautų HTTP serverį.
* Galite pasirinktinai apima statinius priemonės, kurių bus surinkti į HTML kataloge šalia visų savo teikiamų puslapiuose.
* Markdoc ateina su visiškai funkcinis grynas Python WSGI paraiškos ir HTTP serveris aptarnauja iki apibendrina wiki.
* Jūs galite padaryti savo wiki su iš reklamos kainos plėtinių, pavyzdžiui, pygments įsikūrusio kodas išryškinimas, ilgą sintaksė raiškos sąrašus, TOC kartos et cetera įvairovė.
* Jūs galite visiškai pritaikyti, kaip jūsų projektas turi lydyti redaguodami Jinja2 naudojami šablonai konvertuoti, priimtą reklamos kainos į Pilna HTML dokumentus.
"Greitas startas"
Įrengimas:
#! / Bin / bash
Hg klonas SSH: //hg@bitbucket.org/zacharyvoase/markdoc
CD markdoc /
PIP įdiegti -R REIKALAVIMUS
pitonas setup.py įdiegti
Padaryti Wiki
#! / Bin / bash
markdoc paleidimui mano-wiki
CD MY-Wiki /
Vim Wiki / somefile.md
# ... Parašyti dokumentus ...
markdoc statyti
markdoc tarnauti
# .. Atvira http: // localhost: 8008 / naršyklėje ...
Maketas "
Markdoc wiki turėti tokią numatytąją išdėstymą:
WIKI_ROOT /
| - Html /
| - .templates /
| - Tmp /
| - Statinis /
| - Wiki /
`- Markdoc.yaml
Html / tmp ir / Katalogai turėtų būti išbraukti iš bet VCS, nes jie yra laikinuosius failus.
Pasikonsultuokite išdėstymo dokumentaciją doc / wiki / layout.md gauti daugiau informacijos apie įvairių pakatalogius vaidmenų
Reikalavimai .
- Python,
- PIP;
- rsync
Komentarai nerastas