fix(create-docusaurus): Improve init template README, fix headings and remove $ in bash code blocks (#11157)
Some checks failed
Argos CI / take-screenshots (push) Has been cancelled
Build Hash Router / Build Hash Router (push) Has been cancelled
Canary Release / Publish Canary (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Continuous Releases / Continuous Releases (push) Has been cancelled
E2E Tests / E2E — Yarn v1 (18.0) (push) Has been cancelled
E2E Tests / E2E — Yarn v1 (20) (push) Has been cancelled
E2E Tests / E2E — Yarn v1 (22) (push) Has been cancelled
E2E Tests / E2E — Yarn Berry (node-modules, -s) (push) Has been cancelled
E2E Tests / E2E — Yarn Berry (node-modules, -st) (push) Has been cancelled
E2E Tests / E2E — Yarn Berry (pnp, -s) (push) Has been cancelled
E2E Tests / E2E — Yarn Berry (pnp, -st) (push) Has been cancelled
E2E Tests / E2E — npm (push) Has been cancelled
E2E Tests / E2E — pnpm (push) Has been cancelled

This commit is contained in:
Arien Shibani 2025-05-08 18:10:21 +02:00 committed by GitHub
parent e905b93c90
commit 53fa0ecb1f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -2,40 +2,40 @@
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
### Installation
## Installation
```bash
$ yarn
yarn
```
### Local Development
## Local Development
```bash
$ yarn start
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
## Build
```bash
$ yarn build
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
## Deployment
Using SSH:
```bash
$ USE_SSH=true yarn deploy
USE_SSH=true yarn deploy
```
Not using SSH:
```bash
$ GIT_USER=<Your GitHub username> yarn deploy
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.