You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
37 lines
689 B
37 lines
689 B
5 years ago
|
# Website
|
||
|
|
|
||
|
|
This website is built using Docusaurus 2, a modern static website generator.
|
||
|
|
|
||
|
|
### Installation
|
||
|
|
|
||
|
|
```
|
||
|
|
$ yarn
|
||
|
|
```
|
||
|
|
|
||
|
|
### Local Development
|
||
|
|
|
||
|
|
```
|
||
|
|
$ yarn start
|
||
|
|
```
|
||
|
|
|
||
|
|
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
|
||
|
|
|
||
|
|
```
|
||
|
|
$ yarn build
|
||
|
|
```
|
||
|
|
|
||
|
|
This command generates static content into the `build` directory and can be
|
||
|
|
served using any static contents hosting service.
|
||
|
|
|
||
|
|
### Deployment
|
||
|
|
|
||
|
|
```
|
||
|
|
$ GIT_USER=<Your GitHub username> USE_SSH=1 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.
|