yume/juniper
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
juniper/docs/book
History
Christian Legnitto 17e564c6f0
Use bash for docs scripts 
This is erroring out on CI as `pipefail` is a bash-ism AFAICT.
2019-04-15 21:41:00 -07:00
..
content (book) Remove inexistant tutorial link 2019-04-10 03:00:35 +02:00
tests Add support for the canonical introspection query 2019-04-04 09:11:20 +02:00
.gitignore (book) Update and fix book compilation and tests 2019-03-08 11:47:13 +01:00
book.toml (book) Update and fix book compilation and tests 2019-03-08 11:47:13 +01:00
ci-build.sh Use bash for docs scripts 2019-04-15 21:41:00 -07:00
README.md (book) Update and fix book compilation and tests 2019-03-08 11:47:13 +01:00
yarn.lock (book) Update and fix book compilation and tests 2019-03-08 11:47:13 +01:00

README.md

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.