Markdoc je vynikající pro technické dokumentace, manuály, interní projekt wiki, nebo statické generace webu.
Za technickou dokumentaci / příručky, Markdoc může být použit k napsání a učinit ručně psané návody a manuály pro software. Tato dokumentace bude obvykle oddělený od automaticky generované dokumentace API, a může poskytnout pohled na vyšší úrovni než Dokumentace API osamocený. To by mohlo být použito pro dokumentaci klienta pro web / desktopové aplikace, nebo dokonce vývojářské dokumentace pro rámce.
Pro interní projekt Wiki, Markdoc wiki sestávat z jednoho prostého textového souboru na stránku. Kombinací wiki s DVCS (jako Mercurial nebo GIT), můžete spolupracovat s několika dalšími lidmi. Použijte DVCS sledovat, sdílet a sloučit změny s sebou, a zobrazit wiki & rsquo; s historii.
U statického webu generace, Markdoc převádí wiki do raw HTML soubory a média. To vám umožní spravovat blog, osobní webové stránky nebo sbírku stránek ve Markdoc wiki, snad s vlastní CSS styly, a publikovat vykreslený HTML na internetových stránkách. Markdoc nemusí být nainstalován na hostitelském webu, protože výsledný HTML je zcela nezávislý
Vlastnosti :.
- Nastavení Google sledování Analytics v jednom řádku konfigurace.
- Barebone wiki, že stejně vypadají jako adresáře s Markdown formátované textové soubory v nich.
- Zabudovaný HTTP server a WSGI aplikace sloužit až kompilovaný wiki s jediným příkazem.
- Průběžné staví (přes rsync) znamenají, že server může utíkat, zatímco Markdoc znovu zkompiluje wiki. Jen aktualizujte prohlížeče vidět změny.
- Přidat Pygments-poháněl zvýrazňování syntaxe do svého Markdoc wiki s jediným parametrem konfigurace.
- Markdoc je software public domain. To bude vždy zcela zdarma k použití, a můžete jej šířit (částečně nebo zcela) za žádných okolností (open-source, proprietární nebo jinak) bez přičítání nebo encumberances.
Požadavky na
- argparse
- CherryPy
- Jinja2
- Markdown
- Pygments
- PyYAML
- webob
- Python 2.4 nebo novější
- rsync
Komentáře nebyl nalezen