Setup the documentation

The documentation for QuantSA can be found here

The source code is in markdown and is based on: https://github.com/tomjohnson1492/documentation-theme-jekyll.

The source code can be found here

To compile this documentation locally to review your edits, follow any of the many instructions online for building and running a Jekyll site. For example at the site for the very theme that we are using here: http://idratherbewriting.com/documentation-theme-jekyll/.

But in short once everything is setup:

• open a command prompt with ruby
• navigate to the root folder of these the docs
• run jekyll serve or for some unknown reason in my setup: bundle exec jekyll serve

Maths

The following example shows how to include maths.

Note this does not work on Github static pages.