Skip to content

这是个啥?

这是一个基于 vitepress 的组件库主题,对于 vitepress 原有样式并不作过多魔改,单纯的增加了组件库相关功能支持.致力于做一个最轻最干净的组件库框架

相对于 vitepress 扩展的功能:

  • 支持 react 组件
  • changelog 解析与查询
  • react 示例组件动态编译
  • 组件单测覆盖率展示
  • 组件 api
  • task list 支持

为什么要开发这个 Theme ?

最近公司要自研组件库,调研了一圈常见的组件库方案。发现多少有点不足, so 自己动手丰衣足食。

调研过程

分别调研 tdesign / antd/arcod/semid/dumi/histories 建站方案及相关源码。

tdesign: 基于vite+markdown-it 完成 md 渲染,内部包含大量腾讯内部冗余处理,且部分依赖库闭源。

antd: 与 dumi 同渲染方案,内部通过 webpack 构建remark 进行渲染

semidstorybook+gatsby+webpack 极其复杂, 但他的实时编译让我眼前一亮

arcodstorybook+ 闭源

histories: 只支持 vue / svelte

对比后组件库建站方案提取:选择最轻量级方案 vite+markdown-it 方案渲染 markdown,这与vitepress/tdesign同方案

既然 vitepress 已经帮我们把渲染层的问题搞定了, 那就再添加一些组件库的能力即可,因此就有了这个项目