Markdoc je zaměřena na řízení technické dokumentaci, ale může být použit k celé řadě účelů. Markdoc má několik pozoruhodných prodejních míst:
* Wiki jsou tvořeny zcela z holého textu souborů, takže můžete snadno dát je pod správou verzí.
* Wiki sestavit do samostatných HTML adresářů, které mohou být distribuovány jako tarballs nebo sloužil pomocí HTTP serveru.
* Můžete případně zahrnout statické média, který se sestavují do HTML adresáře vedle všech svých poskytovaných stránek.
* Markdoc přichází s plně funkčním pure-Python WSGI aplikačním a HTTP server pro servírují kompilované wiki.
* Můžete poskytnout svůj wiki s řadou rozšíření snížení ceny, jako například Pygments bázi kódu zvýraznění, rozšířené syntaxe pro seznamům definic, TOC generace, et cetera.
* Můžete zcela přizpůsobit, jak se vaše wiki vykreslen úpravou šablony Jinja2 používané pro převod vykreslení Markdown do plných HTML dokumentů.
Rychlý start
Instalace:
#! / Bin / bash
hg clone ssh: //hg@bitbucket.org/zacharyvoase/markdoc
CD markdoc /
Pip nainstalovat -r POŽADAVKY
python setup.py nainstalovat
Vytvoření Wiki
#! / Bin / bash
markdoc init moje-wiki
CD my-wiki /
vim wiki / somefile.md
# ... Napsat nějakou dokumentaci ...
markdoc build
markdoc sloužit
# .. Open http: // localhost: 8008 / v prohlížeči ...
Rozvržení
Markdoc wiki mají následující výchozí rozvržení:
WIKI_ROOT /
| - .html /
| - .templates /
| - TMP /
| - Statická /
| - Wiki /
`- Markdoc.yaml
.html / Tmp a / adresáře by měly být vyloučeny z jakýchkoli VCS, protože obsahují dočasné soubory.
Obraťte se na dokumentaci k rozložení v doc / wiki / layout.md Pro více informací o rolích různých podadresářů
Požadavky na :.
- Python
- PIP
- rsync
Komentáře nebyl nalezen