Markdoc este excelent pentru documentația tehnică, manuale, wiki proiect intern, sau generații site static.
Pentru documentația tehnică / Manuale, Markdoc poate fi folosit pentru a scrie și face ghiduri și manuale scrise de mână pentru software-ul. O astfel de documentație va fi, în mod normal separate de documentare API generate de automat, și s-ar putea da o vedere nivel mai ridicat decât docs API numai. Acesta ar putea fi folosite pentru documentare client pentru aplicatii web / desktop, sau chiar documentația pentru dezvoltatori pentru cadre.
Pentru proiect intern Wiki, wiki Markdoc consta dintr-un singur fișier text simplu pe pagină. Prin combinarea un wiki cu o DVCS (cum ar fi Mercurial sau Git), puteți colabora cu mai multe alte persoane. Utilizați DVCS pentru a urmări, cota și merge modificări cu un altul, și să vizualizați wiki & rsquo; s istorie.
Pentru Static Site Generation, Markdoc convertește wiki în fișiere HTML prime și mass-media. Acest lucru vă permite să gestionați un blog, site-ul personal sau o colecție de pagini într-un wiki Markdoc, probabil, cu stiluri CSS personalizate, și publică HTML prestate la un site web. Markdoc nu trebuie instalat pe site-ul de găzduire, deoarece HTML rezultat este complet independent
Caracteristici :.
- Configurați Google Google Analytics de urmărire într-un linie de configurare.
- uscățivă wiki care arata la fel ca directoarele cu fișiere text Markdown-formatate în ele.
- A built-in server HTTP și aplicarea WSGI a servi un wiki compilat cu o singură comandă.
- construiește continuu (prin rsync) înseamnă serverul poate continua să fie difuzate în același timp Markdoc re-compilează wiki. Doar refresh browser-ul dvs. pentru a vedea modificările.
- Adăugați sintaxa Pygments-alimentat subliniind pentru wiki Markdoc cu un parametru de configurare singur.
- Markdoc este un software domeniu public. Acesta va fi întotdeauna complet libertatea de a folosi, și îl puteți redistribui (în parte sau în totalitate) în orice circumstanțe (open-source, proprietate sau altfel), cu nici o atribuire sau encumberances.
Cerințe :
- argparse
- CherryPy
- Jinja2
- Markdown
- Pygments
- PyYAML
- webob
- Python 2.4 sau mai mare
- rsync
Comentariile nu a fost găsit