Markdoc er fremragende til teknisk dokumentation, manualer, internt projekt wikier, eller statisk websted generationer.
For teknisk dokumentation / Manualer, kan Markdoc bruges til at skrive og gøre håndskrevne vejledninger og manualer til software. Denne dokumentation vil normalt være adskilt fra automatisk genereret API-dokumentation, og kan give et højere niveau visning end API docs alene. Det kan anvendes til klient dokumentation til web / desktop applikationer, eller endda udvikler dokumentation for rammer.
For Intern Projekt Wikis, Markdoc wikier bestå af en enkelt almindelig tekst fil pr side. Ved at kombinere en wiki med et DVCS (såsom Mercurial eller Git), kan du samarbejde med flere andre mennesker. Brug DVCS at spore, dele og flette ændringer med hinanden, og se wiki & rsquo; s historie.
For statisk websted Generation, Markdoc konverterer wikier i rå HTML-filer og medier. Dette giver dig mulighed for at styre en blog, personlig hjemmeside eller en samling af sider i et Markdoc wiki, måske med brugerdefinerede CSS, og udgive den gengives HTML til et websted. Markdoc behøver ikke at blive installeret på hosting site, da den resulterende HTML er helt uafhængig
Funktioner :.
- Opsæt Google Analytics sporing i en linje af konfiguration.
- Barebones wikier, der bare ligner mapper med Markdown-formaterede tekstfiler i dem.
- En indbygget HTTP-server og WSGI ansøgning om at tjene op en kompileret wiki med en enkelt kommando.
- Kontinuerlig bygger (via rsync) betyder serveren kan holde kørende, mens Markdoc igen kompilerer wikien. Bare genopfriske din browser for at se ændringerne.
- Tilføj Pygments-drevne syntaksfremhævning til din Markdoc wiki med en enkelt konfiguration parameter.
- Markdoc er public domain-software. Det vil altid være helt gratis at bruge, og du kan redistribuere det (i helt eller delvist) under nogen omstændigheder (open source, proprietære eller andet) uden tilskrivning eller encumberances.
Krav :
- argparse
- CherryPy
- Jinja2
- Markdown
- Pygments
- PyYAML
- webob
- Python 2.4 eller højere
- rsync
Kommentarer ikke fundet