预览和构建文档
Storybook 允许您创建丰富而广泛的文档,这将帮助您和参与开发过程的任何其他利益相关者。开箱即用,您拥有不仅可以编写文档,还可以预览和构建文档所需的工具。
预览 Storybook 的文档
在您开发的任何阶段,您都可以预览您编写的文档。 当您使用 --docs
标志时,Storybook 允许您生成最终文档的预览。 我们建议将其包含在您的 package.json
中作为新脚本
{
"scripts": {
"storybook-docs": "storybook dev --docs"
}
}
根据您的配置,当您执行 storybook-docs
脚本时。 Storybook 将被置于文档模式,并将生成不同的构建。
它将查找 MDX 或 CSF 中可用的任何 stories,并根据您添加的文档显示它...
与正常的 Storybook 构建相比,此构建模式有一些注意事项
- 顶层项目指的是组件的主要 story。
- 每个单独的 story 现在都处于扁平显示模式,具有一组不同的图标。 这使得焦点集中在文档本身上。
- Storybook 的布局呈现方式不同。 工具栏将不会显示。
发布 Storybook 的文档
您也可以像发布您的 Storybook 一样发布您的文档。 您可以将 --docs
标志与 storybook build
命令一起使用。 我们也建议将其作为脚本包含在您的 package.json
文件中
{
"scripts": {
"build-storybook-docs": "storybook build --docs"
}
}
根据您的配置,当执行 build-storybook-docs
脚本时,Storybook 将再次被置于文档模式,并将生成不同的构建,并将文档输出到 storybook-static
文件夹中。
上述相同的注意事项将适用。
您可以使用任何托管服务提供商来部署您的文档,例如
了解更多关于 Storybook 文档的信息