Documentation

Local Development

Prerequisites

To preview your changes to the documentation before committing them, you can use jekyll, a static site generator.

You need to have ruby installed in order to use jekyll and bundle:

# ruby-dev is required to build native headers
$ sudo apt install ruby-dev ruby-bundler

After you got those, navigate to the docs/ folder from the main repository:

$ cd docs

Then, run:

$ bundle install

to install the dependencies. You only need to run this once to set jekyll up.

Server

You will want to run this command to start watching for file changes and start a web server:

# *nix systems:
$ bundle exec jekyll serve --config _config.local.yml

# windows:
$ bundle exec jekyll serve --config _config.local.yml --force_polling

You can then go to localhost:4000 to review your changes.