2021-03-05 00:12:12 -08:00
|
|
|
# Website
|
|
|
|
|
|
|
|
|
|
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
yarn install
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Local Development
|
|
|
|
|
|
|
|
|
|
```console
|
2021-03-05 12:20:31 -08:00
|
|
|
yarn run lint
|
|
|
|
|
yarn run generate
|
|
|
|
|
yarn run start
|
2021-03-05 00:12:12 -08:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
|
|
|
|
|
|
|
|
|
|
## Build
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
yarn build
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
|
|
|
|
|
|
|
|
|
## Deployment
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
|
2021-09-22 17:30:15 -07:00
|
|
|
|
|
|
|
|
## Generating GraphQL API Docs
|
|
|
|
|
|
|
|
|
|
To regenerate GraphQL API docs, simplym rebuild the docs-website directory.
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
./gradlew docs-website:build
|
|
|
|
|
```
|
