Documentation is in ::docs and is entirely in markdown with Maruku extensions.



Your documentation must conform to the existing documentation style. A template has been provided for you in the file template.mkd.tmpl.

Extensions and post-processing

There’s a few changes to the raw markdown that will occur when they are converted to HTML.

Testing your documentation

Maruku is required to render the markdown into html. Run make in the base directory of the documentation sources and point your web browser at the files.

The CSS is not included in the repository, so there won’t be any formatting.

Submitting patches for documentation and the website

Copyright 2012 William Orr

Copyright 2015 Kylie McClain