halo/docs
1
0
Fork 0
mirror of https://github.com/halo-dev/docs.git synced 2025-08-29 09:31:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update readme.md

Browse Source
This commit is contained in:
Ryan Wang
2021-11-23 20:51:14 +08:00
committed by GitHub
parent a7d8e2be48
commit c7e2767763
1 changed files with 10 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -1,17 +1,23 @@
# 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.
### Installation
```
$ yarn
$ pnpm install
```
> If you don’t have pnpm installed, you can install it with the following command:
```
npm install -g pnpm
```
### Local Development
```
$ yarn start
$ pnpm 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.
@@ -19,15 +25,7 @@ This command starts a local development server and opens up a browser window. Mo
### Build
```
$ yarn build
$ pnpm build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
```
$ 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.