Markdoc

Markdoc is uitstekend voor technische documentatie, handleidingen, interne project wiki's of statische site generaties.
Voor technische documentatie / handleidingen, kan Markdoc worden gebruikt om te schrijven en te maken met de hand geschreven gidsen en handleidingen voor software. Dergelijke documentatie zal normaal gesproken gescheiden worden van automatisch gegenereerde API-documentatie, en kan een hoger niveau uitzicht dan API docs alleen geven. Het kan worden gebruikt voor client-documentatie voor web / desktop applicaties, of zelfs ontwikkelaars documentatie voor kaders.
Interne Project Wiki's, Markdoc wiki's bestaan ​​uit een enkel platte tekst bestand per pagina. Door het combineren van een wiki met een DVCS (zoals Mercurial en Git), kunt u samen met een aantal andere mensen. Gebruik de DVCS op te sporen, te delen en veranderingen met elkaar samen te voegen, en bekijk de wiki & rsquo; s geschiedenis.
Voor statische site Generation, Markdoc zet wiki's in raw HTML-bestanden en media. Hiermee kunt u een blog, persoonlijke website of een verzameling van pagina's in een Markdoc wiki, misschien wel met aangepaste CSS-stijlen beheren en publiceren van de gerenderde HTML naar een website. Markdoc hoeft niet te worden geïnstalleerd op de hosting site, omdat de resulterende HTML is volledig onafhankelijk

Eigenschappen .

• Stel Google Analytics in een lijn van de configuratie.
• Barebone wiki's die net uitzien als mappen met Markdown opgemaakte tekstbestanden in hen.
• Een ingebouwde HTTP-server en WSGI applicatie om te dienen tot een gecompileerde wiki met een enkel commando.
• Continu bouwt (via rsync) betekent dat de server kunnen blijven draaien terwijl Markdoc re-compileert de wiki. Vernieuwen gewoon uw browser om de wijzigingen te zien.
• Voeg Pygments-powered syntax highlighting uw Markdoc wiki met een enkele instelling.
• Markdoc is publiek domein software. Het zal altijd volledig gratis te gebruiken, en je kunt het herdistribueren (gedeeltelijk of geheel) onder alle omstandigheden (open-source, proprietary of anderszins) zonder toekenning of encumberances.

Eisen

• argparse
• cherrypy
• Jinja2
• Markdown
• Pygments
• PyYAML
• webob
• Python 2.4 of hoger
• rsync