Markdoc är utmärkt för teknisk dokumentation, manualer, interna projekt wikis, eller statisk webbplats generationer.
För teknisk dokumentation / handböcker, kan Markdoc användas för att skriva och göra handskrivna guider och manualer för mjukvara. Sådan dokumentation kommer normalt att vara skild från automatiskt genererade API-dokumentation, och kan ge en uppfattning högre nivå än enbart API-dokumentation. Det kan användas för klientdokumentation för webb / skrivbordsprogram, eller till och med utvecklardokumentation för ramar.
För Internal Project Wikis, Markdoc wikis bestå av en enda vanlig textfil per sida. Genom att kombinera en wiki med DVCS (såsom Mercurial eller Git), kan du samarbeta med flera andra personer. Använd DVCS att spåra, dela och sammanfoga ändringar med varandra och visa wikin och rsquoen; s historia.
För statisk Site Generation, omvandlar Markdoc wikis till rå HTML-filer och media. Detta gör att du kan hantera en blogg, personlig hemsida eller en samling av sidor i en Markdoc wiki, kanske med anpassade CSS-format och publicera den återgivna HTML till en webbplats. Markdoc behöver inte installeras på webbhotellet, eftersom den resulterande HTML är helt oberoende
Egenskaper .
- Konfigurera Google Analytics spårar i en rad av konfigurationen.
- Barebones wikis som bara ser ut som kataloger med Wiki-formaterade textfiler i dem.
- En inbyggd HTTP-server och WSGI ansökan om att tjäna upp en kompilerad wiki med ett enda kommando.
- Kontinuerlig bygger (via rsync) gör servern kan hålla igång medan Markdoc åter samman wikin. Bara uppdatera din webbläsare för att se ändringarna.
- Lägg Pygments-driven syntaxmarkering till din Markdoc wiki med ett enda konfigurationsparameter.
- Markdoc är programvara public domain. Det kommer alltid att vara helt gratis att använda, och du kan distribuera det (delvis eller helt) under några omständigheter (öppen källkod, egen eller på annat sätt) utan tilldelning eller encumberances.
Krav :
- argparse
- cherrypy
- Jinja2
- Wiki
- Pygments
- PyYAML
- webob
- Python 2.4 eller högre
- rsync
Kommentarer hittades inte