Skip to content

Commit

Permalink
fix(v2): Fix markdownlint rules on template init/README #3465
Browse files Browse the repository at this point in the history
  • Loading branch information
felipecrs authored and slorber committed Sep 29, 2020
1 parent b95c06b commit 3b6c970
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions packages/docusaurus-init/templates/classic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,32 @@

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

### Installation
## Installation

```
$ yarn
```console
yarn install
```

### Local Development
## Local Development

```
$ yarn start
```console
yarn start
```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

### Build
## Build

```
$ yarn build
```console
yarn build
```

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

### Deployment
## Deployment

```
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
```console
GIT_USER=<Your GitHub username> USE_SSH=true 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 3b6c970

Please sign in to comment.