toot/docs/documentation.md

Documentation

Documentation is generated using mdBook.

Documentation is written in markdown and located in the docs directory.

Additional plugins:

• mdbook-toc

Install prerequisites

You'll need a moderately recent version of Rust (1.60) at the time of writing. Check out mdbook installation docs for details.

Install by building from source:

cargo install mdbook mdbook-toc

Generate

HTML documentation is generated from sources by running:

mdbook build

To run a local server which will rebuild on change:

mdbook serve