Markdoc

Markdoc er utmerket for teknisk dokumentasjon, manualer, internt prosjekt wikier, eller statisk nettsted generasjoner.
For teknisk dokumentasjon / håndbøker, kan Markdoc brukes til å skrive og gjengi håndskrevne guider og manualer for programvare. Slik dokumentasjon vil normalt være atskilt fra automatisk generert API dokumentasjon, og kan gi en overordnet oversikt enn API docs alene. Det kan brukes til klient dokumentasjon for web / desktop-applikasjoner, eller enda utvikler dokumentasjon for rammer.
For internt prosjekt wikier, Markdoc wikier består av en enkelt ren tekst fil per side. Ved å kombinere en wiki med DVCS (som Mercurial eller Git), kan du samarbeide med flere andre personer. Bruk DVCS å spore, dele og slå sammen endringer med hverandre, og vise wiki & rsquo; s historie.
For statisk nettsted Generation, konverterer Markdoc wikier inn rå HTML-filer og media. Dette lar deg administrere en blogg, personlig nettside eller en samling av sider i en Markdoc wiki, kanskje med tilpassede CSS-stiler, og publisere gjengis HTML til et nettsted. Markdoc trenger ikke være installert på fiendtlig sted, siden den resulterende HTML er helt uavhengig

Egenskaper .

• Sett opp Google Analytics sporing på én linje av konfigurasjon.
• Bones wikier som bare ser ut som kataloger med Markdown-formaterte tekstfiler i dem.
• En innebygd HTTP-server og WSGI program for å tjene opp en kompilert wiki med en enkel kommando.
• Kontinuerlig bygger (via rsync) mener at serveren kan fortsette å kjøre mens Markdoc re-kompilerer wiki. Bare oppdatere nettleseren din for å se endringene.
• Legg Pygments drevne syntax highlighting til din Markdoc wiki med en enkelt konfigurasjonsparameter.
• Markdoc er public domain programvare. Det vil alltid være helt gratis å bruke, og du kan distribuere det (delvis eller helt) under noen omstendigheter (åpen kildekode, proprietær eller annet) uten henvisninger eller encumberances.

Krav

• argparse
• Cherrypy
• Jinja2
• Markdown
• Pygments
• PyYAML
• webob
• Python 2.4 eller nyere
• rsync