https://github.com/volcengine/vescaleweb
veScale Website
https://github.com/volcengine/vescaleweb
Last synced: 5 months ago
JSON representation
veScale Website
- Host: GitHub
- URL: https://github.com/volcengine/vescaleweb
- Owner: volcengine
- Created: 2024-03-25T21:38:14.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T23:35:44.000Z (almost 2 years ago)
- Last Synced: 2024-09-18T03:54:20.789Z (almost 2 years ago)
- Language: TypeScript
- Homepage:
- Size: 26.4 MB
- Stars: 3
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# veScale Documentation
📄 Documentation for veScale.
## Translation
Currently veScale provides documentation in English and Chinese. If you can use Chinese, please update both documents at the same time. Otherwise, just update the English documentation.
```bash
root
└─ docs
├─ en # English Document
└─ zh # Chinese Document
```
## Contributing
This website is built with [Rspress](https://rspress.dev), the document content can be written using markdown or mdx syntax. You can refer to the [Rspress Website](https://rspress.dev) for detailed usage.
The source code of Rspress can be found in [this folder](https://github.com/web-infra-dev/rspress).
If you have any problems using the Rspress, please create a new issue at [Rspress Issues](https://github.com/web-infra-dev/rspress/issues).
### Install pnpm
```bash
# enable pnpm with corepack
# only available on node >= `v14.19.0`
corepack enable
# or install pnpm 7 directly
npm install -g pnpm@7
```
### Local Development
```bash
pnpm install
pnpm run dev
```
### Production Build
```bash
pnpm run build
```