Markdoc on suunnattu hallintaan tekninen dokumentaatio, mutta voidaan käyttää eri tarkoituksiin. Markdoc on muutamia merkittäviä myyntivaltteja:
* Wikit koostuvat kokonaan selväkielisenä tiedostoja, joten voit helposti laittaa niille versionhallinta.
* Wikit koota osaksi standalone HTML hakemistoja, joita voidaan jakaa Tar-paketit tai palvelee HTTP-palvelin.
* Voit halutessasi kuuluu staattisia mediaa, joka kootaan HTML hakemistoon rinnalla kaikki sulatettu sivuille.
* Markdoc tulee täysin toimiva puhdas-Python WSGI sovellus ja HTTP-palvelimen, jossa tarjoillaan koottu wikejä.
* Voit tehdä oman wiki erilaisia Markdown laajennuksia, kuten Pygments-pohjainen koodin korostus, laajennettu syntaksi määritelmän luetteloita, TOC sukupolvi, jne.
* Voit täysin muokata miten wiki on suoritettu muokkaamalla Jinja2 malleja käytetään muuntamaan sulatettu Markdown täyteen HTML asiakirjoja.
Pika
Asennus:
#! / Bin / bash
hg klooni ssh: //hg@bitbucket.org/zacharyvoase/markdoc
cd markdoc /
PIP asentaa -r VAATIMUKSET
python setup.py asentaa
Making Wiki
#! / Bin / bash
markdoc init my-wiki
cd my-wiki /
vim wiki / somefile.md
# ... Kirjoittamaan dokumentaatiota ...
markdoc rakentaa
markdoc palvelevat
# .. Auki http: // localhost: 8008 / selaimessa ...
Layout
Markdoc wikit ovat seuraavat oletusasettelua:
WIKI_ROOT /
| - .html /
| - .templates /
| - .tmp /
| - Staattiset /
| - Wiki /
`- Markdoc.yaml
.html / Ja .tmp / hakemistot olisi jätettävä tahansa VCS, koska ne sisältävät tilapäistiedostot.
Consult layout asiakirjat doc / wiki / layout.md lisätietoja roolit eri alihakemistojen.
vaatimukset
- Python
- PIP
- rsync
Kommentteja ei löytynyt