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

• Install mdbook-admonish (for styling)

cargo install mdbook-admonish

• Run build

mdbook build

Warning: Recompile when mdbook is updated

mdbook-tera 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/context.toml:

Setting	Description
version	version of Rhai
repoHome	points to the root of the GitHub repo
rootUrl	sub-directory for The Book, e.g. /book