https://github.com/privoce/vocechat-doc
Documentation of VoceChat
https://github.com/privoce/vocechat-doc
documentation vocechat
Last synced: about 1 year ago
JSON representation
Documentation of VoceChat
- Host: GitHub
- URL: https://github.com/privoce/vocechat-doc
- Owner: Privoce
- Created: 2022-09-15T01:59:11.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-06T13:41:07.000Z (over 1 year ago)
- Last Synced: 2024-11-06T14:36:24.306Z (over 1 year ago)
- Topics: documentation, vocechat
- Language: MDX
- Homepage: https://doc.voce.chat
- Size: 6.94 MB
- Stars: 9
- Watchers: 2
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ pnpm install
```
### Local Development
```
$ 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.
### Build
```
$ pnpm 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 pnpm deploy
```
Not using SSH:
```
$ GIT_USER= pnpm 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.