Markdoc är inriktad på att hantera teknisk dokumentation, men kan användas för en rad ändamål. Markdoc har några anmärkningsvärda säljargument:
* Wikis består helt av klartextfiler, så att du kan enkelt lägga dem under versionskontroll.
* Wikis sammanställa i fristående HTML kataloger, som kan distribueras som tarbollarna eller betjänas av en HTTP-server.
* Du kan eventuellt innehålla statiska media som kommer att sammanställas i HTML katalog tillsammans med alla dina utförda sidor.
* Markdoc levereras med en fullt fungerande ren-Python WSGI ansökan och HTTP-server för att betjäna upp kompilerade wikis.
* Du kan göra din wiki med en mängd olika markdown förlängningar, såsom Pygments-baserad kod framhäva utökad syntax för definitionslistor, TOC generation, et cetera.
* Du kan helt anpassa hur din wiki återges genom att redigera Jinja2 mallar som används för att omvandla återges Wiki i hela HTML-dokument.
Snabbstart
Installation:
#! / Bin / bash
hg klon SSH: //hg@bitbucket.org/zacharyvoase/markdoc
cd markdoc /
Pip installera -r KRAV
python setup.py installera
Göra en Wiki
#! / Bin / bash
markdoc init my-wiki
cd min-wiki /
vim wiki / somefile.md
# ... Skriva någon dokumentation ...
markdoc build
markdoc tjäna
# .. Öppna http: // localhost: 8008 / i en webbläsare ...
layout
Markdoc wikis har följande standardlayouten:
WIKI_ROOT /
| - .html /
| - .templates /
| - Tmp /
| - Statisk /
| - Wiki /
'- Markdoc.yaml
Den .html / och .tmp / kataloger bör undantas från alla VCS, eftersom de innehåller temporära filer.
Konsultera layout dokumentation i doc / wiki / layout.md för mer information om de roller olika underkataloger
Krav .
- Python
- pip
- rsync
Kommentarer hittades inte