入门
- 安装插件
yarn add @sheriffmoose/storybook-md -D
- 添加插件并在您的 main.js 中更新故事导入
module.exports = {
...
"stories": [
"../*.@(md|html)",
"../src/**/*.stories.@(js|jsx|ts|tsx)"
],
"addons": [
"@sheriffmoose/storybook-md",
...
],
...
}
- 如果需要，可以选择传递
mdInclude和/或mdExclude选项，如下所示
module.exports = {
addons: [
{
name: '@sheriffmoose/storybook-md',
options: {
mdInclude: path.join(process.cwd(), 'src'),
mdExclude: [/\.component\.html/] // Disable loading Angular component files
}
}
]
}
就是这样，您完成了。现在，如果您需要，您还将在 Storybook 侧边栏中找到 README 和 CHANGELOG 以及 HTML 文档，您可以打开它们并查看内容。
阅读更多
我撰写了一系列文章来解释此插件背后的动机和目的。欢迎阅读。
Addon-Kit 是开发人员梦寐以求的工具Storybook Markdown 文档（非 mdx）Storybook Markdown 文档（非 mdx）第 2 部分用于自动 Markdown 导入的 Storybook 插件在 Storybook 中支持 .html 文件
还要确保查看使此插件成为可能的这些 PR
