Skip to content

Commit

Permalink
chore: update readme (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
uncenter authored Oct 12, 2023
1 parent 1319ab1 commit c2c719b
Showing 1 changed file with 8 additions and 26 deletions.
34 changes: 8 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,22 @@

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

### Installation
## Development

```
$ yarn
```

### Local Development

```
$ 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
Install dependencies:

```
$ yarn build
pnpm install
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:
Start the development server:

```
$ USE_SSH=true yarn deploy
pnpm start
```

Not using SSH:
The `start` command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

```
$ GIT_USER=<Your GitHub username> yarn deploy
```
## License

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.
[MIT](LICENSE)

0 comments on commit c2c719b

Please sign in to comment.