Mukan Erkin Törük
26b204bd04
Some checks are pending
Docs Deploy / build_and_deploy (push) Waiting to run
Generate Docs / cli (push) Waiting to run
Generate Config Doc / cli (push) Waiting to run
Go formatting / go-formatting (push) Waiting to run
Check links / markdown-link-check (push) Waiting to run
Integration / pre-test (push) Waiting to run
Integration / test on (push) Blocked by required conditions
Integration / status (push) Blocked by required conditions
Lint / Lint Go code (push) Waiting to run
Test / test (ubuntu-latest) (push) Waiting to run
48 lines
837 B
Markdown
48 lines
837 B
Markdown
# Website
|
|
|
|
This website is built using [Docusaurus 2](https://docusaurus.io), a modern static website generator.
|
|
|
|
### Installation
|
|
|
|
```
|
|
yarn
|
|
```
|
|
|
|
### Local Development
|
|
|
|
```
|
|
yarn serve
|
|
```
|
|
|
|
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
|
|
```
|
|
|
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
|
|
|
### Deployment
|
|
|
|
Using SSH:
|
|
|
|
```
|
|
USE_SSH=true yarn deploy
|
|
```
|
|
|
|
Not using SSH:
|
|
|
|
```
|
|
GIT_USER=<Your GitHub username> 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.
|
|
|
|
### Add new version
|
|
|
|
```bash
|
|
$ yarn run docusaurus docs:version v0.25.2
|
|
```
|
|
|