文档文档
Storybook 文档

如何记录组件

在开发过程中编写组件故事时,您也会创建一些基本文档以供日后参考。

Storybook 提供了工具,您可以使用这些工具扩展这些基本文档,并添加散文和布局,从而突出显示您的组件和故事。这使您能够创建 UI 库使用指南、设计系统站点等。

Docs page

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

此外,您还可以根据需要自定义此模板,或使用 MDX 为每个组件创建自由格式的页面。在这两种情况下,您都将使用文档块作为构建块来创建功能齐全的文档。

在大多数用例中,文档会自动配置为开箱即用。在某些情况下,您可能需要或希望调整配置。此处提供了更多信息。