Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Nov 2, 2023
1 parent cecad29 commit ca29d07
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 37 deletions.
4 changes: 2 additions & 2 deletions README-DEVELOP.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
## Initial setup

```bash
npx create-docusaurus@3.0.0-rc.1 website classic --typescript
npx create-docusaurus@3.0.0 website classic --typescript
```

## Install dependencies

```
```bash
cd website
npm install
```
Expand Down
41 changes: 6 additions & 35 deletions website/README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,12 @@
# Website

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

### Installation
To create a similar folder, use:

```
$ 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

```
$ yarn build
```

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

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```bash
npx create-docusaurus@3.0.0 website classic --typescript
```

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.
(to be fully accurate, this folder was created with 3.0.0-rc.1 and
updated to 3.0.0 when released)

0 comments on commit ca29d07

Please sign in to comment.