kjuulh/rhai
1
0
Fork 0
Code Issues 1 Pull Requests 1 Packages Projects Releases Wiki Activity
f99703f951
rhai/doc
History
Stephen Chung f99703f951 Add Engine::disable_doc_comments and smarter doc-comments treatment.
2020-12-20 20:05:23 +08:00
..
src Add Engine::disable_doc_comments and smarter doc-comments treatment. 2020-12-20 20:05:23 +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