1
0
mirror of https://github.com/ihabunek/toot.git synced 2024-06-09 06:10:43 +00:00
toot/docs/documentation.md
2023-03-03 17:12:59 +01:00

743 B

Documentation

Documentation is generated using mdBook.

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

Additional plugins:

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