README.md

Table of Contents

• Supporting
• Contributors
• Contributing
  • Text
    • Formatting
    • Setup
  • Site
    • With local theme

Supporting

If you'd like to read the Guide, and if you can afford to purchase it or if your company reimburses you for educational materials (most do 👍), we would value your support: https://graphql.guide.

Contributors

/GraphQLGuide/book/graphs/contributors

Thank you to everyone who has contributed 😃 🙌

Contributing

We welcome issues and PRs! For large changes, we recommend opening an issue first to get feedback before putting in the work of a PR. Minor things like typo fixes or suggested re-wordings can go directly to PRs and will usually get a quick response 😊

Text

Formatting

• Use curly quotes (“ ‘ ’ ”) unless inside code blocks, in which case use straight quotes (' ")

Setup

If you're working on gitbook-related issues or want to see how your PR will be formatted, follow these steps to get set up after cloning:

npm i -g gitbook-cli
gitbook install
mkdir out/
cd scripts
./build.sh

Site

With local theme

git clone https://github.com/GraphQLGuide/gatsby-theme-apollo.git
git clone https://github.com/GraphQLGuide/book.git
cd book/
connect-deps link ../gatsby-theme-apollo/packages/gatsby-theme-apollo-docs ../gatsby-theme-apollo/packages/gatsby-theme-apollo-core --connect --watch

---

Changelog