mdBook

Details about our mdBook setup.

Installation

To install cargo, run the following command:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

To install mdBook, run the following command:

# Install mdbook v0.4.52 (required for mdbook-embedify compatibility)
cargo install mdbook --version 0.4.52

Install required preprocessors:

cargo install mdbook-mermaid
cargo install mdbook-embedify

To build the book, run the following command:

mdbook build

To serve the book, run the following command:

npx serve book -p 3000

The configuration file is located at book.toml.

We've enabled the following features:

Giscus: To enable comments on the book. See mdbook-embedify for more details.
Mermaid: To enable diagrams in the book. See mdbook-mermaid for more details.