摘要:在技术文档这条赛道上,很多前端开发者可能首先接触的是 VuePress。但最近几年,一个更快、更轻、更现代的工具正在快速崛起,它的名字叫做VitePress。
在技术文档这条赛道上,很多前端开发者可能首先接触的是 VuePress。但最近几年,一个更快、更轻、更现代的工具正在快速崛起,它的名字叫做 VitePress。
这不是一个平凡的工具。它是 VuePress 作者本人推出的下一代文档生成器,也是为了更好地适配 Vue 3 和 Vite 而生。如果你还没接触过 VitePress,现在正是时候。
VitePress 是一个基于 Vite 和 Vue 3 构建的静态网站生成器。它最大的特点是:极速开发、轻量打包、原生支持 Vue 组件。
你可以把它理解为 VuePress 的“极速进化版”。相比 VuePress 依赖 webpack 打包,VitePress 使用的是 Vite 这个超快构建工具,因此在开发体验和构建性能上都遥遥领先。
VitePress 的启动速度非常快,几乎是秒开级别。修改内容后,浏览器自动刷新,所见即所得,体验极其流畅。
你不仅可以写 Markdown,还可以在页面中直接嵌入 Vue 组件,做到文档即代码,代码即文档。这一点在写组件库文档或代码示例时非常有用。
得益于 Vite 的极致性能,VitePress 在构建阶段比 VuePress 更快,输出的静态文件更小。非常适合部署到 GitHub Pages、Vercel、Netlify 等平台。
VitePress 默认主题已经很好用,支持侧边栏、导航栏、自动生成目录、搜索等功能。不需要太多配置,就能快速搭建出一个专业的文档站点。
总结一句话:老项目可以继续用 VuePress,新的文档项目建议直接上 VitePress。
VitePress 目前主要被用于以下几类项目:
无论是开发团队还是个人开发者,只要你想把 Markdown 变成一个好看的网站,VitePress 都是非常合适的选择。
一个典型的 VitePress 项目结构大致如下:
docs/├── .vitepress/ # 配置文件和主题放在这里│ └── config.js├── index.md # 首页内容├── guide/│ └── getting-started.md└── components/ # 可复用的 Vue 组件通过简单的配置,就可以定义侧边栏、导航栏、布局风格,甚至引入自定义组件。
缺点插件生态还在建设中。VitePress 并没有像 VuePress 一样的插件机制,这对于部分有特殊需求的用户来说可能需要自行扩展。主题相对简洁。适合不追求花哨样式的技术文档,如果想要强定制风格,需要自己开发主题。不兼容 Vue 2。如果你的项目还在用 Vue 2,VitePress 不适合直接引入。VitePress 并不是为“内容创作者”准备的,它是为开发者而生的文档引擎。它不仅提供了快速、现代的开发体验,还保留了 Markdown 写作的纯净和 Vue 的灵活性。
如果你正准备为项目写一份像样的文档,又或者想把技术博客变成一个漂亮的网站,不妨给 VitePress 一个机会。哪怕只是体验一下那种“写一行字,一秒后页面就更新”的快感,也值了。
来源:梦回故里归来