2022-07-01 11:52:39 +00:00
|
|
|
# Website
|
|
|
|
|
|
2023-11-29 12:06:05 +00:00
|
|
|
This website is built using [Docusaurus 3](https://docusaurus.io/).
|
2022-07-01 11:52:39 +00:00
|
|
|
|
|
|
|
|
### Installation
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ npm install
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Local Development
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ npm 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
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ npm run 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 npm run deploy
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Not using SSH:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ GIT_USER=<Your GitHub username> npm run 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.
|
