To build these docs,
install mdBook from its download page
(unless you have a recent Rust toolchain, in which case you would just cargo install mdbook),
and run this command:
mdbook serve --open
Above command will (conveniently) open the documentation in a web browser.
See mdBook docs for more detail on how it works.
optional dependencies
Following are additional (and optional) executables to install:
mdbook-mermaidfor displaying Mermaid diagrams (download page)mdbook-tocfor displaying table of contents on individual chapters (download page)mdbook-admonishfor displaying pretty side content (download page)
licenses
This project is under MIT License, and a copy is included at the root of the repository.
Dependencies:
- Mermaid is under MIT license, and so are its bundled assets, mermaid.min.js.
- mdbook-admonish is under MIT license, and so are its bundled assets, mdbook-admonish.css
- mdbook-toc is under MPL license