envd-docs

This website is built using VitePress, Vite & Vue Powered Static Site Generator.

Installation

npm i -g pnpm
pnpm i

Local Development

# 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

# 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
• When you add new file to the docs, please add config of sidebar menu in /docs/vitepress/config/sidebar.ts
• We have enabled 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:

<custom-title title="index.ts">

Your codeblock

</custom-title>

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/.