update docs

This commit is contained in:
Harvey committed 2022-04-28 14:35:45 +08:00
1 parent f2b755ef35
commit cc6151d0bd
125 files changed
+22998 -64478

No files matched your search

+20 -12
View File
@@ -2,32 +2,40 @@
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
## Installation
### Installation
```console
yarn install
```
$ yarn
```
## Local Development
### Local Development
```console
yarn start
```
$ yarn 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
### Build
```console
yarn build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
### Deployment
```console
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
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.