Skip to content

Commit

Permalink
docs: Update docs/README for npm commands and automated deployment pr…
Browse files Browse the repository at this point in the history
…ocess.
  • Loading branch information
junhaoliao committed Jan 3, 2025
1 parent c90ad46 commit 94fc45a
Showing 1 changed file with 7 additions and 16 deletions.
23 changes: 7 additions & 16 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,32 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
This website is built using [Docusaurus][docusaurus], a modern static website generator.

### Installation

```
$ yarn
$ npm install
```

### Local Development

```
$ yarn start
$ npm run 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

```
$ yarn 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:
This site is automatically deployed by [a GitHub workflow][deploy-github-pages] on every push to the `main` branch.

```
$ 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.
[docusaurus]: https://docusaurus.io/
[deploy-github-pages]: /.github/workflows/deploy-gh-pages.yaml

0 comments on commit 94fc45a

Please sign in to comment.