storybook-addon-compodoc

在 Storybook 中为选定 Story 的 Angular 组件显示 Compodoc 页面

工作原理？

注意：这仅适用于 Angular 组件！

这个插件添加了一个面板，它将显示与选定 Story 中的组件相关的 Compodoc 页面。

安装

npm install storybook-addon-compodoc --save-dev (或者 --save-optional 或其他适合你的方式)

配置

注册插件

不要忘记在你的 addons.js 文件中注册插件。为此，你应该包含 import 'storybook-addon-compodoc/register; 这一行。

在 config.js 中

在你的 config.js Storybook 文件中，使用 configureCompodoc 提供 Compodoc 生成的文档部署的 URL，并使用 addDecorator(withCompodoc()) 添加全局装饰器，例如：

import {configureCompodoc,withCompodoc} from 'storybook-addon-compodoc';
...
configureCompodoc({
  compodocUrl:'https://example.com/compodoc'
});
addDecorator(withCompodoc());

在每个 story 中

在每个 story 文件中，你必须提供带有组件类名的参数，最好的方式是使用 addParameters 方法，例如：

const stories = storiesOf("Components/MyComponent", module);

stories.addParameters({
  componentClassName: "MyComponent"
});

待办事项

• 初始可用版本
• 优雅地处理错误和缺失的配置
• 至少为公共方法提供类型定义（配置对象）
• 尝试获取组件名称，而无需手动提供
• 更新待办事项