Skip to content

Commit

Permalink
Add README.md to Classic Docusaurus Template
Browse files Browse the repository at this point in the history
Documentation is linking to the README of the classic template, which is
throwing a 404 as a README does not exist. Documentation link:
https://github.com/facebook/docusaurus/blob/main/packages/create-docusaurus/templates/classic/README.md

Signed-off-by: Colton Padden <colton.padden@fastmail.com>
  • Loading branch information
cmpadden committed Dec 19, 2021
1 parent 18cb13d commit fd1508c
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions packages/create-docusaurus/templates/classic/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Website

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

### Installation

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

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.

0 comments on commit fd1508c

Please sign in to comment.