Markdoc

Markdoc jest ukierunkowany zarządzania dokumentacją techniczną, ale może być stosowany do wielu celów. Markdoc ma kilka znaczących punktów sprzedaży:
* Wiki są wykonane całkowicie z plików tekstu jawnego, dzięki czemu można łatwo umieścić je pod kontrolą wersji.
* Wiki skompilować do autonomicznych katalogów HTML, które mogą być dystrybuowane jako tarballs lub obsługiwanych przez serwer HTTP.
* Można ewentualnie zawierać materiały statyczne, które zostaną skompilowane do katalogu HTML obok wszystkich świadczonych na stronach.
* Markdoc jest wyposażony w pełni funkcjonalny czystej Python i aplikacji WSGI serwera HTTP dla obsługujących skompilowane wiki.
* Możesz spowodować, że wiki z różnymi rozszerzeniami Markdown, takich jak podświetlanie Pygments kodu, opartej składni rozszerzonym rozdzielczości, tworzenia list TOC, et cetera.
* Możesz całkowicie dostosować sposób swoją wiki staje edytując szablony Jinja2 używane do konwersji świadczonych w pełne Markdown dokumentów HTML.
Szybki
Instalacja:
#! / Bin / bash
hg clone ssh: //hg@bitbucket.org/zacharyvoase/markdoc
cd markdoc /
pip install -r WYMAGANIA
python setup.py install
Wykonywanie Wiki
#! / Bin / bash
markdoc init, my-wiki
cd my-wiki /
vim wiki / somefile.md
# ... Napisać dokumentację ...
markdoc build
markdoc służyć
# .. Open http: // localhost: 8008 / w przeglądarce ...
Układ
Wiki Markdoc mają następujący układ domyślny:
WIKI_ROOT /
| - .html /
| - .templates /
| - .tmp /
| - Statyczne /
| - Wiki /
`- Markdoc.yaml
.html / I .tmp / katalogi powinny być wyłączone z jakichkolwiek VCS, ponieważ zawierają pliki tymczasowe.
Zapoznaj się z dokumentacją układu w doc / wiki / layout.md więcej informacji na temat roli różnych podkatalogów

Wymagania .

• Python
• pip
• rsync