react-component-docs React组件可视化文档
组件的自动可视化文档工具 react-component-docs，用起来还挺爽的，尤其是你有一堆 React 组件想快速预览和梳理文档时。它能帮你一键生成文档视图，界面清爽，结构也清晰。虽然现在还没上 npm，但从源码装一下也不复杂，稍微动点手就能跑起来。
源码安装的步骤比较简单，装个 typescript，拉项目：
npm install -g typescript
git clone https://github.com/han4wluc/react-component-docs.git
cd react-component-docs
tsc
npm link
cd example
react-component-docs跑完之后，浏览器里打开 http://localhost:8080/webpack-dev-server/，文档效果就能看到了。默认样式不花哨，但挺实用，适合做内部组件库文档。
比较适合场景是：你做了多个小组件，比如 Button、Modal、FormItem 这种，想给团队里的人用，他们不用看代码，点开文档就能看 props 和示例，节省不少沟通成本。
要注意一点，目前只能本地跑，还不能一键部署到线上。想放到团队内部网站用的话，得自己改下构建逻辑。
如果你平时喜欢用 Storybook，但觉得太重，这个工具算是一个轻量替代，反应也快，没那么多配置。对了，感兴趣的话可以对比下 Datalith 或 Kalileo，也是可视化相关的组件方案。
，如果你手上有组件，又懒得写文档，不妨试试 react-component-docs，反正本地跑起来也快，踩不踩坑，一试便知。
文件大小：17.42KB
评论区