Markdoc teknik dokümantasyon yönetimi yönelikse, ancak çeşitli amaçlar için kullanılabilir. Markdoc birkaç önemli satış noktaları vardır:
* Wiki şifresiz dosyaları tamamen yapılır, böylece kolayca sürüm kontrolü altında koyabilirsiniz.
* Wiki bir HTTP sunucusu tarafından tar olarak dağıtılan ya da servis edilebilir bağımsız HTML dizinleri içine derlemek.
* İsteğe bağlı olarak, tüm işlenmiş sayfaları yanında HTML dizine derlenmiş olacak statik medyayı içerebilir.
* Markdoc derlenmiş wiki kadar hizmet için tam fonksiyonlu saf Python WSGI uygulama ve HTTP sunucusu ile birlikte geliyor.
* Böyle vesaire Pygments tabanlı kod vurgulama, tanım listeleri için uzatılmış sözdizimi, TOK nesil olarak Markdown uzantıları, çeşitli ile wiki hale getirebilir.
* Sen tamamen wiki tam HTML belgeleri içine işlenen Markdown dönüştürmek için kullanılan Jinja2 şablonlar düzenleyerek hale nasıl özelleştirebilirsiniz.
Quickstart
Kurulum:
#! / Bin / bash
hg clone ssh: //hg@bitbucket.org/zacharyvoase/markdoc
cd markdoc /
-r GEREKSİNİMLERİ yüklemek pip
Python yüklemek setup.py
Bir Wiki Yapımı
#! / Bin / bash
markdoc benim-wiki init
cd my-wiki /
vim wiki / somefile.md
# ... Bazı belgelerine yazmak ...
markdoc inşa
markdoc hizmet
# .. Açık http: // localhost: Bir tarayıcıda 8008 / ...
Düzen
Markdoc wiki aşağıdaki varsayılan düzeni var:
WIKI_ROOT /
| - .html /
| - .templates /
| - .tmp /
| - Statik /
| - Wiki /
`- Markdoc.yaml
Onlar geçici dosyaları içeren bu yana .html / ve .tmp / dizinleri, herhangi bir VCS uzak tutulmalıdır.
/ Wiki / layout.md çeşitli dizinlerinin rolleri hakkında daha fazla bilgi için doc düzen belgelerine başvurun
Gereksinimleri :.
- Python
- pip
- rsync
Yorum Bulunamadı