storybook-addon-compodoc

显示 Compodoc 中选定故事的 Angular 组件页面 Storybook

它是如何工作的？

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

此附加组件添加了一个面板，该面板将显示与选定故事中的组件相关的 Compodoc 页面。

安装

npm install storybook-addon-compodoc --save-dev（或--save-optional或适合您的任何选项）

配置

注册附加组件

不要忘记在您的addons.js文件中注册附加组件。为此，应在其中包含import 'storybook-addon-compodoc/register;行。

在 config.js 中

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

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

在每个故事中

在每个故事文件中，您必须提供一个包含组件类名的参数，最好的方法是使用addParameters方法，例如：

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

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

待办事项

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