Markdoc

Markdoc diarahkan mengelola dokumentasi teknis, tetapi dapat digunakan untuk berbagai tujuan. Markdoc memiliki beberapa nilai jual penting:
* Wiki terdiri sepenuhnya dari file plaintext, sehingga Anda dapat dengan mudah menempatkan mereka di bawah kontrol versi.
* Wiki kompilasi ke direktori HTML mandiri, yang dapat didistribusikan sebagai tarball atau dilayani oleh server HTTP.
* Anda opsional dapat meliputi media statis yang akan dikompilasi ke dalam direktori HTML bersama semua halaman Anda diberikan.
* Markdoc dilengkapi dengan aplikasi dan HTTP murni Python WSGI Server yang berfungsi penuh untuk melayani sampai wiki yang disusun.
* Anda dapat membuat wiki Anda dengan berbagai penurunan harga ekstensi, seperti kode Pygments berbasis penyorotan, sintaks diperpanjang untuk daftar definisi, generasi TOC, dan lain-lain.
* Anda benar-benar dapat menyesuaikan bagaimana wiki Anda diberikan dengan mengedit template Jinja2 digunakan untuk mengkonversi diberikan penurunan harga dalam dokumen HTML penuh.
Quickstart
Instalasi:
#! / Bin / bash
hg clone ssh: //hg@bitbucket.org/zacharyvoase/markdoc
cd markdoc /
pip menginstal PERSYARATAN r
python setup.py install
Membuat Wiki
#! / Bin / bash
markdoc init saya-wiki
cd my-wiki /
vim wiki / somefile.md
# ... Menulis beberapa dokumentasi ...
markdoc membangun
markdoc melayani
# .. Http terbuka: // localhost: 8008 / di browser ...
Tata Letak
Wiki Markdoc memiliki tata letak default berikut:
WIKI_ROOT /
| - Html /
| - .templates /
| - .tmp /
| - Statis /
| - Wiki /
`- Markdoc.yaml
The html / tmp dan / direktori harus dikeluarkan dari setiap VCS, karena mengandung file-file sementara.
Konsultasikan dokumentasi tata letak di doc / wiki / layout.md untuk informasi lebih lanjut tentang peran dari berbagai subdirektori

Persyaratan :.

• Python
• pip
• rsync