juniper/book
Kai Ren ec0d7d8097
Rework Book (#1230)
- rework and update existing chapters
- mention correct case transformation for GraphQL enums (#1029)
- document N+1 mitigation techniques and look-ahead features (#234, #444)
- mention all integration crates (#867)
- fix Book links (#679, #974, #1056)
- remove old version of Book (#1168)

Additionally:
- disable `bson`, `url`, `uuid` and `schema-language` Cargo features by default in `juniper` crate

Co-authored-by: Christian Legnitto <LegNeato@users.noreply.github.com>
2024-03-20 15:53:25 +01:00
..
src Rework Book (#1230) 2024-03-20 15:53:25 +01:00
.gitignore Rework CI and project toolchain (#1043) 2022-04-08 17:44:50 +03:00
book.toml Rework Book (#1230) 2024-03-20 15:53:25 +01:00
README.md Fix mdBook tests on Windows (rust-lang/rust#99466) 2022-11-02 16:32:50 +01:00

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