This website is built using VitePress, Vite & Vue Powered Static Site Generator.
npm i -g pnpm
pnpm ipnpm docs:devThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
pnpm docs:buildThis command generates static content into the build directory and can be served using any static contents hosting service.
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
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>
if you want to write a blog, the following things you need to do
- add new post under
docs/blogthem just wirte the markdown file. - add new item to
/docs/.vitepress/config/sidebar.ts/blog/.