aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/README.md
blob: af2bc4b318ff6f87a66ff5a4e80adc56e760e64a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Readme

Use the following instructions to make documentation changes locally.

## Prerequisites
```bash
$ sudo apt install ruby bundler
$ bundle config set path 'vendor/bundle'
$ bundle install
```

## Serving locally
```bash
$ bundle exec jekyll serve
```

## Theme documentation
We are using the [just the docs](https://pmarsceill.github.io/just-the-docs/)
theme.