2021-06-04 11:17:15 +02:00
|
|
|
# Website
|
|
|
|
|
|
|
|
|
|
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
yarn install
|
|
|
|
|
```
|
|
|
|
|
|
2023-08-17 17:32:57 +02:00
|
|
|
## Generate Open API docs
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
yarn generate
|
|
|
|
|
```
|
2023-08-22 14:40:38 +02:00
|
|
|
|
2023-08-17 17:32:57 +02:00
|
|
|
Generate the Open API docs that live at Reference documentation > APIs > OpenAPI
|
|
|
|
|
|
2021-06-04 11:17:15 +02:00
|
|
|
## Local Development
|
|
|
|
|
|
|
|
|
|
```console
|
|
|
|
|
yarn start
|
|
|
|
|
```
|
|
|
|
|
|
2023-08-22 14:40:38 +02:00
|
|
|
Start a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
|
2021-06-04 11:17:15 +02:00
|
|
|
|
|
|
|
|
## 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.
|
