Skip to content

bogzbonny/book

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The Rhai Book

The Rhai Book serves as Rhai's primary documentation and tutorial resource.

How to Build from Source

cargo install mdbook
cargo install mdbook-tera
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

Releases

No releases published

Packages

No packages published

Languages

  • CSS 49.1%
  • SCSS 48.9%
  • Handlebars 2.0%