An open API service indexing awesome lists of open source software.

https://github.com/graphql-java/graphql-java-page

This is the repo of the GraphQL Java Documentation at www.graphql-java.com
https://github.com/graphql-java/graphql-java-page

Last synced: 2 months ago
JSON representation

This is the repo of the GraphQL Java Documentation at www.graphql-java.com

Awesome Lists containing this project

README

        

# 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](https://docusaurus.io/), 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](/documentation/getting-started.mdx) and the `getting-started` file for your newly created version.

For more, see the [Docusaurus versioning documentation](https://docusaurus.io/docs/versioning).