Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Documentation

This documentation is built with mdBook. The sources live in docs/src/; the build output goes to docs/book/ (git-ignored).

  1. Install rust

  2. Install mdbook

cargo install mdbook
  1. Install this to ensure external links will be opened in a new tab https://crates.io/crates/mdbook-external-links
cargo install mdbook-external-links
  1. Install extention for alerts https://crates.io/crates/mdbook-alerts
cargo install mdbook-alerts

Caution

??? How to prevent the markdown below of being parsed?

> [!NOTE]  
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]  
> Crucial information necessary for users to succeed.

> [!WARNING]  
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.

  1. build the book locally
mdbook serve --open