<!--*-markdown-*-->#MarkdocREADMEMarkdocisalightweightMarkdown-basedwikisystem.It’sgearedtowardsmanagingtechnicaldocumentation,butcanbeusedforarangeofpurposes.Ithasafewnotablesellingpoints:*Wikisaremadeupcompletelyofplaintextfiles,soyoucaneasilyputthemunderversioncontrol.*WikiscompileintostandaloneHTMLdirectories,whichcanbedistributedastarballsorservedbyaHTTPserver.*SetupGoogleAnalyticstrackinginonelineofconfiguration.*CreatebareboneswikisthatjustlooklikefolderscontainingMarkdown-formattedtextfiles.*YoucanoptionallyincludestaticmediawhichwillbecompiledintotheHTMLdirectoryalongsideallyourrenderedpages.*Markdoccomeswithafully-functionalpure-PythonWSGIapplicationandHTTPserverforservingupcompiledwikis.*YoucanrenderyourwikiwithavarietyofMarkdownextensions,suchasPygments-basedcodehighlighting,extendedsyntaxfordefinitionlists,TOCgeneration,etcetera.*YoucancompletelycustomizehowyourwikiisrenderedbyeditingtheJinja2templatesusedtoconvertrenderedMarkdownintofullHTMLdocuments.Quickstart==========Requirements------------TheminimumrequirementstoruntheMarkdocutilityare:*Python2.4orlater(2.5+highlyrecommended)*AUNIX(oratleastPOSIX-compliant)operatingsystem*[rsync](http://www.samba.org/rsync/) -- installed out of the box with most modern OSes, including Mac OS X and Ubuntu. In the future Markdoc may include a pure-Python implementation.Installation------------#!bash$easy_installMarkdocMakingaWiki-------------#!bash$markdocinitmy-wiki$cdmy-wiki/$vimwiki/somefile.md#...writesomedocumentation...$markdocbuild$markdocserve#..openhttp://localhost:8008/ in a browser ...Layout======Markdocwikishavethefollowingdefaultlayout:WIKI_ROOT/|--.html/|--.templates/|--.tmp/|--static/|--wiki/`--markdoc.yamlThe`.html/`and`.tmp/`directoriesshouldbeexcludedfromanyVCS,sincetheycontaintemporaryfiles.Consultthelayoutdocumentationin`doc/wiki/ref/layout.md`formoreinformationontherolesofvarioussubdirectories.