跳到正文

什么是 VitePress ​

VitePress 是由 Vue 团队打造的静态站点生成器(SSG),专为技术文档与个人知识库设计。

核心特性 ​

  • Vite 驱动:毫秒级冷启动,热更新即时生效。
  • Vue 语法嵌入:可在 Markdown 中直接使用 Vue 组件与交互逻辑。
  • 内置主题:默认主题已包含导航栏、侧边栏、深色模式、全文搜索等文档常用能力。
  • 静态输出:构建后生成纯 HTML,可部署到任何静态托管平台。

常用命令 ​

命令说明
npm run docs:dev启动本地开发服务器
npm run docs:build构建生产版本到 .vitepress/dist
npm run docs:preview本地预览构建产物

下一步 ​

在 docs/ 目录下新建 .md 文件即可新增页面,并在 docs/.vitepress/config.mts 中配置对应的导航与侧边栏。

这是图片

基于 VitePress 构建