这半年来感情受挫使我这个 30 岁的老男人不得一改以往懒散的作风,开始代码为伴,借码消愁
随着 vue3 的发布,越来越多的前端老师开始撸起了自己的组件库,与此同时 yyx 老师也给我们带来了更加现代化的打包工具 vite , 体验过的都会对那种丝滑流连忘返
于是众多老师们便开始尝试着使用 vite 来打包组件库的文档站
大部分的组件库文档都是基于 markdown 来编写,而同时它们都有代码预览的功能,下面展示几个案例, 今天要给老师们推荐的就是这个 vite 插件便是用来做这件事的,用来将 markdown 文件转成 vue 组件的并展示一个漂亮的 demo.
github: vite-plugin-vuedoc
使用方式
- 现在你的 vite 项目中安装并使用 vite-plugin-vuedoc 插件 yarn add vite-plugin-vuedoc
// vite.config.ts
import vitePluginVuedoc from 'vite-plugin-vuedoc'
const config: UserConfig = {
plugins: [vitePluginVuedoc()],
}
export default config
- 引入 vite-plugin-vuedoc 的基础样式
import 'vite-plugin-vuedoc/style.css'
- 接下来就可以开始写 markdown 文档了