storybook - Storybook 是一个开源工具，它能有组织和高效地构建 UI 组件，文档编制和测试，包括 React、Vue 和 Angular 。

更快地构建防弹 UI 组件

Storybook 是 UI 组件的开发环境。
它允许你浏览组件库，查看每个组件的不同状态，并以交互方式开发和测试组件。
在 https://storybook.js.org 了解更多信息。

查看自述文件：

目录

• 🚀 开始
• 📒 项目
  • 🛠 支持的框架和示例
  • 🚇 子项目
  • 🔗插件
• 🏅 徽章和演示材料
• 👥 社区
• 👏 贡献
  • 👨 💻 开发脚本
  • 💵 支持者
  • 💸 赞助商
• 📝 许可证

开始

访问Storybook的网站，了解有关Storybook的更多信息，并开始使用。

文档

文档可以在Storybook的文档网站上找到。

例子

以下是一些精选示例，你可以参考这些示例来了解 Storybook 的工作原理：https://storybook.js.org/showcase

Storybook附带了许多用于组件设计，文档，测试，交互性等的插件。Storybook的API可以以各种方式进行配置和扩展。它甚至已经扩展到支持React Native，Android，iOS和Flutter的移动开发。

社区

如需更多帮助，请加入我们的故事书不和谐。

项目

支持的框架

框架	演示
React
维尤
角
网络组件
React Native	-
断续器
余烬
苗条
预作用
木偶.js	-
安卓， iOS， 飘飘

子项目

• CLI - 针对各种应用类型的简化安装
• 示例 - 用于说明不同故事书用例的代码示例

插件

请参阅插件/框架支持表

已弃用的插件

为了继续改善你的体验，我们最终必须弃用某些插件，转而使用新的，更好的工具。

如果你使用的是信息/注释，我们强烈建议你改为迁移到文档，以下是帮助你的指南。

如果你使用的是上下文，我们强烈建议你迁移到工具栏，此处的指南可为你提供帮助。

徽章和演示材料

我们有一个徽章！将其链接到你的实时故事书示例。

[![Storybook](https://cdn.jsdelivr.net/gh/storybookjs/brand@main/badge/badge-storybook.svg)](link to site)

如果你正在寻找用于故事书演示的材料，例如徽标的视频材料和我们使用的颜色等，你可以在我们的品牌存储库中找到所有这些材料。

社区

• 通过@storybookjs发推文
• 在 storybook.js.org 和媒介上写博客
• 在不和谐上聊天
• 流媒体保存在Youtube上

贡献

我们欢迎对故事书的贡献！

• 📥随时欢迎拉取请求和🌟星星。
• 阅读我们的贡献指南以开始使用，或在Discord上找到我们，我们将花时间指导你

寻找要解决的第一个问题？

• 当我们认为问题非常适合刚接触代码库或OSS的人时，我们会标记问题。
• 与我们交谈，我们会找到适合你的技能和学习兴趣的东西。

开发脚本

Storybook使用Lerna组织为monorepo。有用的脚本包括：

yarn bootstrap

安装软件包依赖项并将软件包链接在一起 - 使用 lerna

yarn lint

布尔检查代码是否符合 linting 规则 - 使用 remark & eslint

• yarn lint:js

  - 将检查 js

• yarn lint:md

  - 将检查降价+代码示例

• yarn lint:js --fix

  - 将自动修复js

yarn test

布尔检查单元测试是否全部通过 - 使用 jest

• yarn run test --core --watch

  - 将在监视模式下运行核心测试

赞助商

成为赞助商，并在Github上的README上获取你的徽标，并带有指向你网站的链接。[成为赞助商]

支持者

每月捐款支持我们，并帮助我们继续我们的活动。[成为支持者]

许可证

MIT

-结束-