diff --git a/packages/docusaurus-init/templates/classic/README.md b/packages/docusaurus-init/templates/classic/README.md index ee0ccc9d18..8960fa2afa 100644 --- a/packages/docusaurus-init/templates/classic/README.md +++ b/packages/docusaurus-init/templates/classic/README.md @@ -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= USE_SSH=true yarn deploy +```console +GIT_USER= 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.