diff --git a/examples/README.md b/examples/README.md index a74930f315d1..fc0fbbc6f5c7 100644 --- a/examples/README.md +++ b/examples/README.md @@ -2,7 +2,7 @@ These example projects are generated with the init CLI: -``` +```bash npx @docusaurus/init@latest init examples/ ` ``` diff --git a/examples/classic-typescript/README.md b/examples/classic-typescript/README.md index 0c6c2c27be92..35ad92cc2ae1 100644 --- a/examples/classic-typescript/README.md +++ b/examples/classic-typescript/README.md @@ -4,13 +4,13 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati ### Installation -``` +```bash $ yarn ``` ### Local Development -``` +```bash $ yarn start ``` @@ -18,7 +18,7 @@ This command starts a local development server and opens up a browser window. Mo ### Build -``` +```bash $ yarn build ``` @@ -28,13 +28,13 @@ This command generates static content into the `build` directory and can be serv Using SSH: -``` +```bash $ USE_SSH=true yarn deploy ``` Not using SSH: -``` +```bash $ GIT_USER= yarn deploy ``` diff --git a/examples/classic/README.md b/examples/classic/README.md index 0c6c2c27be92..35ad92cc2ae1 100644 --- a/examples/classic/README.md +++ b/examples/classic/README.md @@ -4,13 +4,13 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati ### Installation -``` +```bash $ yarn ``` ### Local Development -``` +```bash $ yarn start ``` @@ -18,7 +18,7 @@ This command starts a local development server and opens up a browser window. Mo ### Build -``` +```bash $ yarn build ``` @@ -28,13 +28,13 @@ This command generates static content into the `build` directory and can be serv Using SSH: -``` +```bash $ USE_SSH=true yarn deploy ``` Not using SSH: -``` +```bash $ GIT_USER= yarn deploy ``` diff --git a/packages/create-docusaurus/templates/shared/README.md b/packages/create-docusaurus/templates/shared/README.md index 0c6c2c27be92..35ad92cc2ae1 100644 --- a/packages/create-docusaurus/templates/shared/README.md +++ b/packages/create-docusaurus/templates/shared/README.md @@ -4,13 +4,13 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati ### Installation -``` +```bash $ yarn ``` ### Local Development -``` +```bash $ yarn start ``` @@ -18,7 +18,7 @@ This command starts a local development server and opens up a browser window. Mo ### Build -``` +```bash $ yarn build ``` @@ -28,13 +28,13 @@ This command generates static content into the `build` directory and can be serv Using SSH: -``` +```bash $ USE_SSH=true yarn deploy ``` Not using SSH: -``` +```bash $ GIT_USER= yarn deploy ``` diff --git a/packages/docusaurus-theme-translations/README.md b/packages/docusaurus-theme-translations/README.md index d12c98ba443c..0878bf0350ff 100644 --- a/packages/docusaurus-theme-translations/README.md +++ b/packages/docusaurus-theme-translations/README.md @@ -13,7 +13,7 @@ Please help us provide exhaustive translations: After updating the theme code, you can "synchronize" the translations by running: -``` +```bash yarn workspace @docusaurus/theme-translations update ``` diff --git a/packages/lqip-loader/README.md b/packages/lqip-loader/README.md index 458ff3654d49..9c5179d82779 100644 --- a/packages/lqip-loader/README.md +++ b/packages/lqip-loader/README.md @@ -4,7 +4,7 @@ Low Quality Image Placeholders (LQIP) loader for webpack. ## Installation -``` +```bash npm install --save-dev @docusaurus/lqip-loader ```