Updated README for docs

This commit is contained in:
BarsTiger
2022-02-11 14:40:17 +02:00
parent b849b43a6f
commit 8b43963025
3 changed files with 7 additions and 25 deletions

View File

@@ -2,16 +2,18 @@
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
If you want to add something to this website to make docs better, please open a pull request on GitHub.
### Installation
```
$ yarn
$ npm i
```
### Local Development
```
$ 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.
@@ -19,23 +21,7 @@ This command starts a local development server and opens up a browser window. Mo
### Build
```
$ yarn build
$ npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ 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.