0fc95ddbff
- add `codespell` CI job - add `book.codespell` Makefile command - fix Book typos found by codespell Co-authored-by: Kai Ren <tyranron@gmail.com> |
||
|---|---|---|
| .. | ||
| src | ||
| .gitignore | ||
| book.toml | ||
| README.md | ||
Juniper Book
Book containing the juniper user guide.
Contributing
Requirements
The Book is built with mdBook.
You may install it with:
cargo install mdbook
Local test server
To launch a local test server that continually re-builds the Book and auto-reloads the page, run:
mdbook serve
# or from project root dir:
make book.serve
Building
You may build the Book to rendered HTML with this command:
mdbook build
# or from project root dir:
make book
The output will be in the _rendered/ directory.
Testing
To run the tests validating all code examples in the book, run (from project root dir):
cargo build
mdbook test -L target/debug/deps
# or via shortcut:
make test.book