项目介绍
ruabick
是一个基于 VitePress 的组件开发工具。功能设计是抄
的 dumi,但是dumi
目前不支持vue
。而且我觉得使用 VitePress来构建 vue 组件文档更轻量。
INFO
项目前身是 vitepress-for-components
解决问题
VitePress 很轻量很快,但是在写组件文档的场景
下有以下不足之处:
1. 文档和 Demo 得重复写两遍。
2. 文档,Demo 和源码在不同的目录,联系感不强。
源码和 Demo 一般在
src
目录下面,但是 VitePress 通常需要新建一个docs
目录,它们之间应该放在同一个地方。 参考dumi 的目录结构
3. 需要自动生成组件 API 文档功能。
基于
vue-docgen-api
自动生成 api 文档(参考arco-design-vue的代码)。