入门
- 安装插件
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）第二部分用于自动导入 Markdown 的 Storybook 插件在 Storybook 中支持 .html 文件
另外，请务必查看这些使此插件成为可能的 PR
