| .. | ||
| src | ||
| theme | ||
| book.toml | ||
| README.md | ||
The Rhai Book
The Rhai Book serves as Rhai's primary documentation and tutorial resource.
How to Build from Source
- Install
mdbook:
cargo install mdbook
- Install
mdbook-tera(for templating):
cargo install mdbook-tera
- Run build in source directory:
cd doc
mdbook build
Configuration Settings
Settings stored in context.json:
| Setting | Description |
|---|---|
version |
version of Rhai |
repoHome |
points to the root of the GitHub repo |
repoTree |
points to the root of the GitHub repo tree |
rootUrl |
sub-directory for the root domain, e.g. /rhai |