使用vitepress构建组件库文档

使用vitepress构建组件库文档

前期调研

Vitepress

• 官方文档：https://vitepress.vuejs.org/

  • Vitepress是在Vite之上构建的Vue驱动的静态站点生成器。
  • Vitepress 被称为“ Vuepress的小弟弟”，它比同类产品具有一些优势。

• 建立在Vite而非Webpack上，因此启动时间，热重装等更快

• 使用Vue3来减少JS的有效负载

• 轻量级

Vitepress 能够实现这些目标的一个原因是，它比Vuepress 更具体，而 Vuepress在过去几年里变得更加复杂。

虽然不打算完全取代Vuepress作为 Vue 的静态网站生成器，但 Vitepress 提供了一种轻量级的替代方案。 对于大多数项目，例如文档和简单站点，Vitepress的特殊性和简约性将使开发变得轻而易举

官方文档提示

• VitePress 目前处于 0.x 状态。它已经适合开箱即用的文档使用，但配置和主题 API 可能仍会在次要版本之间发生变化。
• 这个早期的WIP（可理解成在制品），目前主要精力专注于Vite的稳定和功能的完整，对于一些serious的事不建议使用它！

PS：偶然发现element-plus的组件库文档就是使用VitePress，放心用住！！！

优势

• 它相当于VuePress，当它将Vue2换成Vue3，把webpack换成vite，因此：
  • 它有VuePress的所有优点；如：可以在md里面混合vue组件等；
  • 具有Vite的速度；如：可以秒开一个VitePress开发服务器以及md的