Skip to content

快速开始 ​

欢迎使用 SiteName 文档站。本页是占位内容,后续替换为你的真实文档。

本地开发 ​

bash
pnpm docs:dev      # 启动开发服务器(默认 http://localhost:5173)
pnpm docs:build    # 构建静态站点到 docs/.vitepress/dist
pnpm docs:preview  # 本地预览构建产物

目录结构 ​

  • docs/.vitepress/config.ts —— 站点配置(i18n、导航、侧边栏、品牌名)
  • docs/.vitepress/theme/ —— 主题样式与全局 Vue 组件
  • docs/index.md —— 中文首页(landing)
  • docs/guide/ —— 中文文档
  • docs/en/ —— 英文版本(/en/ 为英文首页)

Vue 组件 ​

本站已注册全局 Vue 组件 DemoBox,可在任意 Markdown 文件中直接使用:

这是一个全局组件

这是一个在 Markdown 中直接使用的 Vue 组件,证明本站支持自定义 Vue 扩展。

如何新增组件 ​

  1. 在 docs/.vitepress/theme/components/ 下新建 .vue 文件。
  2. 在 docs/.vitepress/theme/index.ts 中用 app.component('Name', Comp) 注册。
  3. 在 Markdown 中写 <Name /> 即可。

这样就实现了「文档 + 自定义 Vue 组件」的均衡扩展能力。

基于 VitePress + Vue 3 构建