Skip to content

快速开始

环境要求

  • Node.js 18 及以上版本

本地运行

bash
# 安装依赖
npm install

# 启动开发服务器(默认端口 5173)
npm run docs:dev

构建与预览

bash
# 构建静态文件,输出至 docs/.vitepress/dist
npm run docs:build

# 本地预览构建结果
npm run docs:preview

新增页面

  1. docs/ 下任意目录创建 .md 文件,例如 docs/guide/my-page.md
  2. docs/.vitepress/config.mtssidebar 中注册该路径:
ts
{ text: '我的页面', link: '/guide/my-page' }
  1. 保存后开发服务器自动刷新。

Released under the MIT License.