docs: documentation generation (#575)

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

View File

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