juniper/book

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:

cd tests/
cargo test

# or from project root dir:
cargo test -p juniper_book_tests

# or via shortcut from project root dir:
make test.book

Test setup

All Rust code examples in the book are compiled on the CI.

This is done using the skeptic crate.