jmug/stoatchat
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

docs: documentation generation (#575)

Browse Source 
Signed-off-by: Damocles078 <hellodamocles078@gmail.com>
This commit is contained in:
Damocles
2026-03-14 08:53:51 +01:00
committed by GitHub
parent ab525699bd
commit f2fc1ee00c
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/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 pnpm install
``` ```
## Local Development ## Local Development
```bash ```bash
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. 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,7 @@ This command starts a local development server and opens up a browser window. Mo
## Build ## Build
```bash ```bash
yarn build pnpm 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.
@@ -29,13 +29,13 @@ This command generates static content into the `build` directory and can be serv
Using SSH: Using SSH:
```bash ```bash
USE_SSH=true yarn deploy USE_SSH=true pnpm run deploy
``` ```
Not using SSH: Not using SSH:
```bash ```bash
GIT_USER=<Your GitHub username> yarn deploy GIT_USER=<Your GitHub username> pnpm run 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.