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

Compare commits

base: dev-public:develop
Branches Tags
dev-public:develop
dev-public:master
..
compare: dev-public:master
Branches Tags
dev-public:develop
dev-public:master

No commits in common. "develop" and "master" have entirely different histories.
develop ... master

1 changed files with 20 additions and 4 deletions
Show Stats Expand all files Collapse all files

24
README.md
View File

@ -5,13 +5,13 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
## Installation ## Installation
```bash ```bash
npm yarn
``` ```
## Local Development ## Local Development
```bash ```bash
npm 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. 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,7 +19,23 @@ This command starts a local development server and opens up a browser window. Mo
## Build ## Build
```bash ```bash
npm build yarn 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:
```bash
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.