https://github.com/rhaiscript/book
The Rhai Book.
https://github.com/rhaiscript/book
documentation examples rhai rhai-book scripting-engine scripting-language tutorials
Last synced: 4 months ago
JSON representation
The Rhai Book.
- Host: GitHub
- URL: https://github.com/rhaiscript/book
- Owner: rhaiscript
- Created: 2021-01-07T06:23:45.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-05-30T06:08:23.000Z (5 months ago)
- Last Synced: 2025-05-30T07:53:52.820Z (5 months ago)
- Topics: documentation, examples, rhai, rhai-book, scripting-engine, scripting-language, tutorials
- Language: CSS
- Homepage: https://rhai.rs/book
- Size: 55.9 MB
- Stars: 24
- Watchers: 3
- Forks: 25
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
The Rhai Book
=============
[_The Rhai Book_](https://rhai.rs/book) serves as Rhai's primary
documentation and tutorial resource.
How to Build from Source
------------------------
* Install [`mdbook`](https://github.com/rust-lang/mdBook)
```sh
cargo install mdbook
```
* Install [`mdbook-tera`](https://crates.io/crates/mdbook-tera) (for templating)
```sh
cargo install mdbook-tera
```
* Install [`mdbook-admonish`](https://crates.io/crates/mdbook-admonish) (for styling)
```sh
cargo install mdbook-admonish
```
* Run `build`
```sh
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](https://github.com/rhaiscript/rhai/blob/master) |
| `rootUrl` | sub-directory for _The Book_, e.g. `/book` |