Markdoc A lightweight Markdown-based wiki system.
Download

Markdoc Ranking & Summary

Markdoc Tags

wiki markup wiki system WSGI application Markdown Markdown-based wiki

Markdoc Description

A lightweight Markdown-based wiki system. Markdoc is geared towards managing technical documentation, but can be used for a range of purposes. Markdoc has a few notable selling points:* Wikis are made up completely of plaintext files, so you can easily put them under version control.* Wikis compile into standalone HTML directories, which can be distributed as tarballs or served by a HTTP server.* You can optionally include static media which will be compiled into the HTML directory alongside all your rendered pages.* Markdoc comes with a fully-functional pure-Python WSGI application and HTTP server for serving up compiled wikis.* You can render your wiki with a variety of Markdown extensions, such as Pygments-based code highlighting, extended syntax for definition lists, TOC generation, et cetera.* You can completely customize how your wiki is rendered by editing the Jinja2 templates used to convert rendered Markdown into full HTML documents.QuickstartInstallation:#!/bin/bashhg clone ssh://hg@bitbucket.org/zacharyvoase/markdoccd markdoc/pip install -r REQUIREMENTSpython setup.py installMaking a Wiki#!/bin/bashmarkdoc init my-wikicd my-wiki/vim wiki/somefile.md# ... write some documentation ...markdoc buildmarkdoc serve# .. open http://localhost:8008/ in a browser ...LayoutMarkdoc wikis have the following default layout:WIKI_ROOT/|-- .html/|-- .templates/|-- .tmp/|-- static/|-- wiki/`-- markdoc.yamlThe .html/ and .tmp/ directories should be excluded from any VCS, since they contain temporary files.Consult the layout documentation in doc/wiki/layout.md for more information on the roles of various subdirectories. Requirements: · Python · pip · rsync

Markdoc Related Software