Files

42 lines
774 B
Markdown
Raw Permalink Normal View History

2026-08-14 15:15:47 +08:00
# Website
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
## Installation
```bash
2026-08-14 15:28:57 +08:00
yarn
2026-08-14 15:15:47 +08:00
```
## Local Development
```bash
2026-08-14 15:28:57 +08:00
yarn start
2026-08-14 15:15:47 +08:00
```
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
```bash
2026-08-14 15:28:57 +08:00
yarn build
2026-08-14 15:15:47 +08:00
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
Using SSH:
```bash
2026-08-14 15:28:57 +08:00
USE_SSH=true yarn deploy
2026-08-14 15:15:47 +08:00
```
Not using SSH:
```bash
2026-08-14 15:28:57 +08:00
GIT_USER=<Your GitHub username> yarn deploy
2026-08-14 15:15:47 +08:00
```
2026-08-14 15:28:57 +08: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.