37a9d02850
If there is no new book content, `git commit` will return `1` and the entire job will error. Took answer from https://stackoverflow.com/questions/8123674/how-to-git-commit-nothing-without-an-error |
||
|---|---|---|
| .. | ||
| content | ||
| tests | ||
| .gitignore | ||
| book.toml | ||
| ci-build.sh | ||
| README.md | ||
| yarn.lock | ||
Juniper Book
Book containing the Juniper documentation.
Contributing
Requirements
The book is built with mdBook.
You can install it with:
cargo install mdbook
Starting a local test server
To launch a local test server that continually re-builds the book and autoreloads the page, run:
mdbook serve
Building the book
You can build the book to rendered HTML with this command:
mdbook build
The output will be in the ./_rendered directory.
Running the tests
To run the tests validating all code examples in the book, run:
cd ./tests
cargo test
Test setup
All Rust code examples in the book are compiled on the CI.
This is done using the skeptic library.