文档文档
Storybook Docs

如何编写组件文档

当你在开发过程中编写组件 stories 时,你也创建了基础文档以便后续查阅。

Storybook 提供了工具,让你能够扩展这些基础文档,通过散文和布局突出展示你的组件和 stories。这使你能够创建 UI 库使用指南、设计系统站点等等。

Docs page

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

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

Docs 经过自动配置,在大多数情况下开箱即用。在某些情况下,你可能需要或想要调整配置。在此处阅读更多相关信息。