Website/README.md

45 lines
768 B
Markdown
Raw Permalink Normal View History

2024-11-30 19:31:24 +00:00
# Website
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
2024-12-02 18:41:26 +00: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.
2024-11-30 19:31:24 +00:00
### Build
```
$ yarn build
```
2024-12-02 18:41:26 +00:00
This command generates static content into the `build` directory and can be served using any static contents hosting
service.
2024-11-30 19:31:24 +00:00
### Deployment
Using SSH:
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ GIT_USER=<Your GitHub username> yarn deploy
```
2024-12-02 18:41:26 +00: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.