2019-08-15 22:07:23 +00:00
|
|
|
# Readme
|
|
|
|
|
|
|
|
|
|
Use the following instructions to make documentation changes locally.
|
|
|
|
|
|
|
|
|
|
## Prerequisites
|
2019-08-06 20:29:19 +00:00
|
|
|
```bash
|
2019-08-15 22:07:23 +00:00
|
|
|
$ sudo apt install ruby bundler
|
2021-08-04 15:19:11 +00:00
|
|
|
$ bundle config set path 'vendor/bundle'
|
|
|
|
|
$ bundle install
|
2019-08-06 20:29:19 +00:00
|
|
|
```
|
|
|
|
|
|
2019-08-15 22:07:23 +00:00
|
|
|
## Serving locally
|
2019-08-06 20:29:19 +00:00
|
|
|
```bash
|
2019-08-15 22:07:23 +00:00
|
|
|
$ bundle exec jekyll serve
|
2019-08-06 20:29:19 +00:00
|
|
|
```
|
|
|
|
|
|
2019-08-15 22:07:23 +00:00
|
|
|
## Theme documentation
|
2019-08-06 20:29:19 +00:00
|
|
|
We are using the [just the docs](https://pmarsceill.github.io/just-the-docs/)
|
|
|
|
|
theme.
|
