Skip to content

Commit

Permalink
chore(docs): Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
clemyan committed Nov 2, 2023
1 parent 6267c41 commit ee90cf4
Showing 1 changed file with 2 additions and 20 deletions.
22 changes: 2 additions & 20 deletions packages/docusaurus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,7 @@

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

### Installation

```
$ yarn
```

### Local Development
### Development

```
$ yarn start
Expand All @@ -26,16 +20,4 @@ This command generates static content into the `build` directory and can be serv

### Deployment

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.
The `master` branch is automatically deployed to https://yarnpkg.com/ via [Netlify](https://www.netlify.com/). Pull Requests are also deployed as Deploy Previews.

0 comments on commit ee90cf4

Please sign in to comment.