This source for documentation is at
docs and built using mdbook. You can trigger a manual build by executing the following command from the project root:
$ yarn build:docs
The resulting files are placed in
Mdbook also supports starting a local web server to render a live preview of changes made to the markdown files:
$ cd docs $ mdbook serve
Currently there are two plugins used during compilation of the documentation. You'll probably have to install them manually.
mdbook-linkcheck is included to check that all links the documentation points to are valid.
mdbook-open-on-gh adds a link to the current page on GitHub at the bottom of each page.
You can install the plugins with cargo from you command line:
$ cargo install mdbook-linkcheck mdbook-open-on-gh