2020-05-13 17:25:42 +01:00
|
|
|
# Website
|
|
|
|
|
|
|
|
|
|
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
|
|
|
|
|
|
|
|
|
|
### Installation
|
|
|
|
|
|
|
|
|
|
```
|
2023-11-03 21:43:12 +00:00
|
|
|
$ pnpm
|
2020-05-13 17:25:42 +01:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Local Development
|
|
|
|
|
|
|
|
|
|
```
|
2023-11-03 21:43:12 +00:00
|
|
|
$ pnpm start
|
2020-05-13 17:25:42 +01: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
|
|
|
|
|
|
|
|
|
|
```
|
2023-11-03 21:43:12 +00:00
|
|
|
$ pnpm build
|
2020-05-13 17:25:42 +01:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
|
|
|
|
|
|
|
|
|
### Deployment
|
|
|
|
|
|
|
|
|
|
```
|
2023-11-03 21:43:12 +00:00
|
|
|
$ GIT_USER=<Your GitHub username> USE_SSH=true pnpm deploy
|
2020-05-13 17:25:42 +01:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
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.
|
