Markdoc

Markdoc est orientée vers la gestion de la documentation technique, mais peut être utilisé pour une gamme de fins. Markdoc a quelques points de vente notables:
* Les wikis sont fait complètement des fichiers en clair, de sorte que vous pouvez facilement les mettre sous contrôle de version.
* Wikis compiler dans des répertoires HTML autonomes, qui peuvent être distribués en archives ou servis par un serveur HTTP.
* Vous pouvez éventuellement inclure les médias statiques qui seront compilées dans le répertoire HTML aux côtés de toutes vos pages rendus.
* Markdoc est livré avec une application et un serveur HTTP entièrement fonctionnel pur-Python WSGI pour servir des wikis compilées.
* Vous pouvez rendre votre wiki avec une variété d'extensions Markdown, tels que la mise en évidence sur la base Pygments-code, la syntaxe étendue pour les listes de définition, la génération de TOC, et cetera.
* Vous pouvez personnaliser complètement la façon dont votre wiki est rendu en modifiant les modèles jinja2 utilisés pour convertir Markdown rendu dans des documents HTML complets.
Quickstart
Installation:
#! / Bin / bash
hg clone ssh: //hg@bitbucket.org/zacharyvoase/markdoc
cd markdoc /
pip installer EXIGENCES -r
python setup.py install
Faire un Wiki
#! / Bin / bash
markdoc à init mon wiki-
cd my-wiki /
vim wiki / somefile.md
# ... Écrire de la documentation ...
markdoc construction
markdoc servir
# .. Http ouverte: // localhost: 8008 / dans un navigateur ...
Mise en page
wikis Markdoc ont la mise en page par défaut suivant:
WIKI_ROOT /
| - .html /
| - .templates /
| - .tmp /
| - Statique /
| - Wiki /
`- Markdoc.yaml
Le .html / tmp et / répertoires devrait être exclu de toute VCS, car ils contiennent des fichiers temporaires.
Consultez la documentation de mise en page dans doc / wiki / layout.md pour plus d'informations sur les rôles des divers sous-répertoires

Exigences :.

• Python
• pip
• rsync