dev-public/doc-workflow-proposal
19
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request 'Update README.md' (#1) from luyen.vo-patch-1 into develop

Browse Source 
Reviewed-on: #1
This commit is contained in:
VO DUY LUYEN 2025-06-23 14:04:40 +08:00
commit d6fe5617ed
1 changed files with 4 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -5,13 +5,13 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
## Installation ## Installation
```bash ```bash
yarn npm
``` ```
## Local Development ## Local Development
```bash ```bash
yarn start npm 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. 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,23 +19,15 @@ This command starts a local development server and opens up a browser window. Mo
## Build ## Build
```bash ```bash
yarn build npm build
``` ```
This command generates static content into the `build` directory and can be served using any static contents hosting service. This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
Using SSH:
```bash
USE_SSH=true yarn deploy
```
Not using SSH: Not using SSH:
```bash ```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. 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.