3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-29 10:17:55 +02:00
Code Issues Projects Releases Packages Wiki Activity

fix(v2): Fix markdownlint rules on template init/README #3465

Browse source
This commit is contained in:
Felipe Santos 2020-09-29 07:23:06 -03:00 • committed by GitHub
parent a28aedcc5c
commit 1c251bca2e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
packages/docusaurus-init/templates/classic/README.md
View file

@ -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.