Overview

Use Just the Docs for documentation

License

In order to build the documentation, we use the Just the Docs theme for Jekyll, which is licensed under the MIT license. Please see that file for the theme’s copyright and permission notices.

Setup for developing locally (Mac)

Requirements

Homebrew

Install Homebrew.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Ruby 3.1

Installed with Homebrew. https://mac.install.guide/ruby/13.html

Check Ruby is installed correctly with

ruby -v

Install dependencies

Install the dependencies listed in the Gemfile using the command:

bundle install

Building locally

bundle exec jekyll build

OR

Run the VSCode task 'Build'

Running locally

bundle exec jekyll serve --livereload

OR

Run the VSCode task 'Serve'

Setup for developing locally (Windows)

https://jekyllrb.com/docs/installation/windows/

Setup for developing locally (Linux)

This guide has been tested on Ubuntu 20.04

Install dependencies

Install prerequisites:

sudo apt-get install build-essential zlib1g-dev

Since there is only old version of Ruby (2.7) available in Ubuntu repos, we need to install RVM:

• https://rvm.io

Then install Ruby 3.1:

rvm install 3.1.0

Install Jekyll and Bundler:

gem install jekyll bundler

Building locally

bundle exec jekyll build

Running locally

bundle exec jekyll serve --livereload

Useful Resources

• https://jekyllrb.com/docs/installation/macos/