https://github.com/tensorchord/envd-docs
envd Website
https://github.com/tensorchord/envd-docs
blog documentation hacktoberfest
Last synced: about 1 year ago
JSON representation
envd Website
- Host: GitHub
- URL: https://github.com/tensorchord/envd-docs
- Owner: tensorchord
- License: apache-2.0
- Created: 2022-06-08T14:24:44.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-12T02:08:27.000Z (over 2 years ago)
- Last Synced: 2024-03-12T03:32:52.589Z (over 2 years ago)
- Topics: blog, documentation, hacktoberfest
- Language: TypeScript
- Homepage: https://envd.tensorchord.ai/
- Size: 3 MB
- Stars: 11
- Watchers: 10
- Forks: 29
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
envd-docs
This website is built using [VitePress](https://vitepress.vuejs.org/), Vite & Vue Powered Static Site Generator.
### Installation
```shell
npm i -g pnpm
pnpm i
```
### Local Development
```shell
# dev en-US docs
pnpm dev
# dev zh-CN docs
pnpm dev:zh
```
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
```shell
# build en-US docs
pnpm build
# build zh-CN docs
pnpm build:zh
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Tips
Recommended to read the following part before you start to contribute the docs.
- Chinese docs is under `/docs-zh`
- VitePress Markdown features [VitePress Markdown](https://vitepress.vuejs.org/guide/markdown.html)
- When you add new file to the docs, please add config of sidebar menu in `/docs/vitepress/config/sidebar.ts`
- We have enabled [AutoCorrect](https://github.com/huacnlee/autocorrect) to improve copywriting, correct spaces, words, punctuations between CJK. If your PR encounter this kind of problems, please check your PR's check result and fix them.
### Custom title for code block
This feature will be offfical supported in the future.
as a workaround, you can use the following syntax:
```vue
Your codeblock
```
### Blog
If you want to write a blog, the following things you need to do
- Add new post under `docs/blog` or `docs-zh/blog` then just write the Markdown file.
- Add new item to `/docs/.vitepress/config/sidebar.ts` or `/docs-zh/.vitepress/config/sidebar.ts` `/blog/`.