kjuulh/rhai
1
0
Fork 0
Code Issues 1 Pull Requests 1 Packages Projects Releases Wiki Activity
a45876856d
rhai/doc
History
Stephen Chung 049ad3b6fd Move rhai-repl and rhai-doc to bin.
2020-12-29 15:36:42 +08:00
..
src Move rhai-repl and rhai-doc to bin. 2020-12-29 15:36:42 +08:00
theme Revise Rhai logo. 2020-12-18 19:12:30 +08:00
book.toml Add linkcheck, fix typos and expand. 2020-06-20 22:56:56 +08:00
README.md Add README for docs. 2020-10-07 13:23:28 +08:00

README.md

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
  • 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