GraphQL Java documentation

Welcome to the GraphQL Java documentation. It's very easy to get started, all you need is Markdown.

Contributions are always welcome. Thanks for helping out!

Local setup

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

Preview build files locally with

$ yarn run serve

How to create a new release

Create a new release by following the below (v20 used as an example)

$ yarn run docusaurus docs:version v20

Then update lastVersion inside docusaurus.config.js

lastVersion: "v20",

Delete the oldest version by deleting the oldest version's directory inside versioned_docs and the corresponding file in versioned_sidebars. Then delete the oldest version from versions.json.

Finally, change the Maven and Gradle sections for the latest docs in documentation/getting-started.mdx and the getting-started file for your newly created version.

For more, see the Docusaurus versioning documentation.