Markdoc è orientata verso la gestione documentazione tecnica, ma può essere utilizzato per una varietà di scopi. Markdoc ha alcuni punti di vendita notevoli:
* I wiki sono costituiti interamente di file di testo in chiaro, in modo da poter facilmente mettere sotto controllo di versione.
* Wikis compila in cataloghi HTML standalone, che possono essere distribuiti come tarball o dei servizi di un server HTTP.
* Facoltativamente, è possibile includere i supporti statici che saranno compilati nella directory HTML insieme tutte le pagine resi.
* Markdoc è dotato di un server applicativo e HTTP puro Python WSGI pienamente funzionale per servire fino wiki compilati.
* È possibile rendere il vostro wiki con una varietà di estensioni Markdown, come il codice evidenziazione-based Pygments, sintassi estesa per le liste di definizione, generazione TOC, et cetera.
* È possibile personalizzare completamente la modalità di wiki è resa modificando i modelli Jinja2 utilizzati per convertire reso Markdown in documenti HTML completi.
Quickstart
Installazione:
#! / Bin / bash
hg clone ssh: //hg@bitbucket.org/zacharyvoase/markdoc
cd markdoc /
Pip installare REQUISITI -r
python setup.py install
Fare un Wiki
#! / Bin / bash
markdoc init my-wiki
cd mia-wiki /
vim wiki / somefile.md
# ... Scrivere qualche documentazione ...
markdoc costruire
markdoc servire
# .. Http aperto: // localhost: 8008 / in un browser ...
Layout
Wiki Markdoc hanno il seguente layout di default:
WIKI_ROOT /
| - .html /
| - .templates /
| - Tmp /
| - Static /
| - Wiki /
`- Markdoc.yaml
Il .html / tmp e / directory dovrebbe essere escluso da qualsiasi VCS, in quanto contengono i file temporanei.
Consultare la documentazione layout in doc / wiki / layout.md Per ulteriori informazioni sui ruoli dei vari sottodirectory
Requisiti .
- Python
- pip
- rsync
I commenti non trovato