react styleguidist

孤立的反应组件开发环境与生活方式指南

React Styleguidist是一个组件开发环境，具有热重新加载的开发服务器和您可以与团队共享的生活方式指南。它列出了基于Markdown文件的propTypes ，可编辑的使用示例。查看演示样式指南。

用法

• 入门：安装和运行styleguidist
• 记录组件：如何编写文档
• 找到组件：point styleguidist的反应组件
• 配置webpack：告诉styleguidist如何加载代码
• 食谱：如何使用StyleGuidist解决常见任务

高级文档

• 配置
• CLI命令和选项
• node.js api

例子

• 基本样式指南，来源
• 带有部分的样式指南，来源
• 带有定制样式的样式指南，来源
• 带有自定义Express端点的样式指南，来源
• 创建React App集成，来源

展示柜

使用React StyleGidist的实际项目：

• 隆隆图表
• 更好的反应型扫描
• 反应的语义UI组件
• 对话框组件
• Bulma组件
• Yammer组件
• 更多项目…

与其他工具集成

• 创建React应用程序 - 开箱即用支持，请参阅“入门指南”
• vue，请参阅Vue Styleguidist

第三方工具

• Snapguidist：React Styleguidist的快照测试
• React-Styleguidist-Visual：使用Puppeteer和PixelMatch的React StyleGidist的自动化视觉测试
• styleguidist-scrapper：React Styleguidist生成的文档的刮擦脚本

资源

• 萨拉·维埃拉（Sara Vieira）
• Robert Haritonov的Building React组件图书馆库的演讲
• 说奶酪：快照和视觉测试
• 与Artem Sapegin有关React StyleGidist的访谈。

更改日志

更改日志可以在“版本”页面上找到。

贡献

欢迎大家做出贡献。请花一点时间阅读贡献指南和开发人员指南。

赞助

成为赞助商，并在Github上获得徽标，并在Github上使用指向您网站的链接。

成为支持者，将您的图像在Github上的Readme上获取指向您网站的链接。

作者和许可证

Artem Sapegin和贡献者。

Sara Vieira和Andrey Okonetchnikov的徽标。

麻省理工学院许可证，请参阅随附的许可证文件。