参加直播:周四,美国东部时间上午 11 点,Storybook 9 发布及 AMA
文档文档
Storybook Docs

如何文档化组件

在开发过程中编写组件 stories 时,您也创建了可以稍后回顾的基本文档。

Storybook 提供了工具来扩展这些基本文档,通过文字描述和布局突出您的组件和 stories。这使您可以创建 UI 库使用指南、设计系统网站等。

Docs page

如果您是首次在项目中引入 Storybook,我们为您提供了一个文档页面(简称“Autodocs”),位于您的 stories 附近。这是一个自动生成的基线模板,列出了您现有的 stories 和相关元数据。

此外,如果需要,您可以自定义此模板,或者使用MDX为每个组件创建自由格式的页面。在这两种情况下,您都将使用文档块(Doc Blocks)作为构建块来创建功能完备的文档。

在大多数用例中,文档功能都已自动配置好,开箱即用。在某些情况下,您可能需要或想要调整配置。您可以在这里阅读更多相关信息。