使用Vue Styleguidist编写组件代码化文档
在日常 Vue 项目开发中,我们难免需要写一些基础公共组件,在大型项目中,我们难免会遇到下面的痛点:
- 组件 API,对于 Vue 组件,有 props、event、slot 等接口,在团队内需要一定的沟通成本
- 对于 UI 组件,还需要提供预览,方便团队内快速选择合适的组件
如果使用 Markdown 撰写,虽然能写 API 文档,但是无法提供组件预览,并且手动写文档的成本也很大
好在有一个这样的库,可以提供自动化文档的生成,并提供组件预览,这个库叫做 Vue Styleguidist
阅读更多