Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
sarahschwartz committed Apr 21, 2024
1 parent 80c98cf commit 24641bb
Showing 1 changed file with 11 additions and 25 deletions.
36 changes: 11 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,27 @@
# Website
# Tutorial Testing Demo

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

## Running Locally

### Installation

```
$ yarn
```sh
pnpm install
```

### Local Development

```
$ yarn start
```sh
pnpm 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.
### Testing the tutorial

### Deployment

Using SSH:

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

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```sh
pnpm test
```

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.
This command runs an end-to-end test for the tutorial.

0 comments on commit 24641bb

Please sign in to comment.