docs: update readme.md

JohnNiang-patch-1
Ryan Wang 3 years ago committed by GitHub
parent a7d8e2be48
commit c7e2767763
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -1,33 +1,31 @@
# Website # The open-source repo for [docs.halo.run](https://docs.halo.run)
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Installation ### Installation
``` ```
$ yarn $ pnpm install
``` ```
### Local Development > If you dont have pnpm installed, you can install it with the following command:
``` ```
$ yarn start npm install -g pnpm
``` ```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. ### Local Development
### Build
``` ```
$ yarn build $ pnpm start
``` ```
This command generates static content into the `build` directory and can be served using any static contents hosting service. This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Deployment ### Build
``` ```
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy $ pnpm build
``` ```
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. This command generates static content into the `build` directory and can be served using any static contents hosting service.

Loading…
Cancel
Save