新的 API 参考文档、TypeScript 代码片段和文档 DX

我们正在让学习 Storybook 变得前所未有的容易

Kyle Gach

Jun 16, 2023 — @kylegach

最近更新 Jun 16, 2023

ChatGPT 可以帮助处理很多事情。但对于学习 Storybook 而言，最好的资源是 Storybook 的官方文档。

我们正在推出新功能来帮助您学习 Storybook 并向我们的学习团队发送反馈。让我们看看下面的主要更新。

新的 API 参考文档

Storybook 反馈中最主要的主题之一是关于功能、库和插件的 API 信息。这就是为什么我们正在文档中推出 API 参考部分，旨在成为一个完整的技术资源。它首先包含以下内容的 API 参考：

接下来是 Parameters 和 Decorators，还有更多内容即将推出。

社区反馈推动了 Storybook 文档的改进。为了帮助您提供反馈，每个页面上都有一个新的反馈小部件，供您分享对特定文档的评论。

一旦您提交反馈，它将被收集在一个公开的 GitHub 讨论中。我们的自动化文档机器人会提供一个链接，方便您订阅您关心的 issue。

自从该小部件启动以来的 6 周内，我们非常感谢已经收到了超过 160 个评分和评论。您的回复帮助我们改进了 Storybook 7 迁移指南，改进了关于 ArgTypes 的文档，并改进了关于将 stories 导入测试的文档，以及其他更改。

您知道哪些文档页面可以改进吗？开始使用反馈小部件并告诉我们。甚至可以打开 PR 并做出贡献。

TypeScript 已成为大多数开发人员的首选语言。如果我们的文档中的代码片段有 TypeScript 版本（大多数都有），Storybook 的文档将默认使用 TypeScript。否则，它会回退到 JavaScript。

任何以 TypeScript 提供的代码片段也以 TypeScript 4.9 提供。这是因为 TS 4.9 启用了 satisfies 的使用，这为您的 Storybook 配置和 stories 带来了更好的类型安全。

作为额外的开发者体验更新，您的代码语言（和渲染器选择）现在会被浏览器记住。您不再需要每次都手动重新选择这些。

最后，包含版本、渲染器和代码语言菜单的工具栏现在会固定在页面顶部。我们希望这有助于您一目了然地确认这些设置，并在必要时快速更改它们。

我们与新用户的许多对话表明，代码片段在您的学习体验中起着至关重要的作用。它们需要是最新的、相关的并且可以立即使用。

为了配合 Storybook 7 的发布，我们审核了文档和教程中的每个代码片段。然后，我们确保我们的每个核心渲染器（React、Vue、Angular 和 Web components）的每个示例都有可用的代码片段。

我们还将每个 CSF 2 代码片段转换为新的 CSF 3（并提供返回到先前版本的链接，供那些尚未准备好升级的用户使用）。

非常感谢所有为我们的学习内容做出贡献或提供反馈的人。您的贡献塑造了 Storybook 的未来。

我们正在创建一个专门创建和维护技术内容的学习团队。如果您有兴趣为 Storybook 做出贡献，我们的学习内容是一个绝佳的起点

在下面注册我们的邮件列表，以便第一时间了解新功能和更新。