Building the Documentation

Dependencies

You should install the following:

• mdbook: https://rust-lang.github.io/mdBook/guide/installation.html
• mdbook-linkcheck: https://github.com/Michael-F-Bryan/mdbook-linkcheck

Both may be installed from source using the same versions as the CI with the following command:

PERMAKEEP_GIT_ROOT=$(git rev-parse --show-toplevel)
cargo install mdbook --version $(cat ${PERMAKEEP_GIT_ROOT}/docs/ci/mdbook_version.txt)
cargo install mdbook-linkcheck --version $(cat ${PERMAKEEP_GIT_ROOT}/docs/ci/mdbook_linkcheck_version.txt)

Commands

The source for the documentation can be found under docs/.

From that directory, you may run any of the following commands:

• Build using make build
• Test using make test
• Run CI equivalent using make ci
• View the docs locally with live reload using make serve