The Rhai Book
October 2, 2025 ยท View on GitHub
The Rhai Book serves as Rhai's primary documentation and tutorial resource.
How to Build from Source
- Install
mdbook
cargo install mdbook
- Install
mdbook-variables(for variables expansion)
cargo install mdbook-variables
- Install
mdbook-admonish(for styling)
cargo install mdbook-admonish
- Run
build
mdbook build
Warning: Recompile when mdbook is updated
mdbook-variables and mdbook-admonish depend on particular versions of mdbook.
When mdbook is updated, it is best to reinstall both plugins to make sure that there are no
version conflicts.
Configuration Settings
Settings are stored in src/book.toml under the [preprocessor.variables.variables] section:
| Setting | Description |
|---|---|
version | version of Rhai |
repoHome | points to the root of the GitHub repo |
rootUrl | sub-directory for The Book, e.g. /book |