Skip to content

This documentations runs on MkDocs

Draft

This is a test version of the documentation site, and this page is a draft. Content is basic for now and will grow.

For full documentation visit mkdocs.org.

Commands

  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file (enable extentions, configure links and header).
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.