Markdoc is gericht beheer van de technische documentatie, maar kan worden gebruikt voor een scala aan toepassingen. Markdoc heeft een paar opmerkelijke selling points:
* Wiki's zijn volledig gemaakt van platte tekst bestanden, zodat u ze gemakkelijk gezet onder versiebeheer.
* Wiki's te compileren in standalone HTML directories, die kan worden gedistribueerd als tarballs of bediend door een HTTP server.
* U kunt desgewenst statische media, die zullen worden opgesteld in de HTML-directory naast al uw pagina's weergegeven.
* Markdoc wordt geleverd met een volledig functionele pure-Python WSGI applicatie en HTTP server voor het serveren samengesteld wiki's.
* U kunt uw wiki met een verscheidenheid van Markdown extensies, zoals Pygments-gebaseerde code highlighting, uitgebreide syntaxis voor de definitie lijsten, TOC generatie, et cetera maken.
* U kunt volledig aanpassen hoe je wiki is gemaakt door het bewerken van de Jinja2 templates gebruikt om verleende Markdown zetten in volledige HTML-documenten.
Quickstart
Installatie:
#! / Bin / bash
hg clone ssh: //hg@bitbucket.org/zacharyvoase/markdoc
cd markdoc /
pip installeren -r EISEN
python setup.py installeren
Het maken van een Wiki
#! / Bin / bash
markdoc init mijn-wiki
mijn cd-wiki /
vim wiki / somefile.md
# ... Brief wat documentatie ...
markdoc build
markdoc dienen
# .. Geopend http: // localhost: 8008 / in een browser ...
Indeling
Markdoc wiki's hebben de volgende standaard lay-out:
WIKI_ROOT /
| - .html /
| - .templates /
| - Tmp /
| - Statische /
| - Wiki /
`- Markdoc.yaml
De .html / en tmp / mappen moeten vanaf elke VCS worden uitgesloten, omdat ze tijdelijke bestanden bevatten.
Raadpleeg de layout documentatie in doc / wiki / layout.md voor meer informatie over de rol van de verschillende subdirectory
Eisen .
- Python
- pip
- rsync
Reacties niet gevonden