storybook-addon-whats-new

它是什么？

这是一个 Storybook 插件，旨在让用户查看仓库的新增功能。建议链接到您的 CHANGELOG.md 以实现自动更新，或者您可以使用 Markdown 文件自定义管理更符合需求的更新。

安全策略

设置安全策略

如何安装？

安装依赖项

yarn add -D storybook-addon-whats-new

Storybook 5.3 及更高版本

然后将其添加到您的 .storybook/main.js 中

module.exports = {
  // other configs here
  addons: ['storybook-addon-whats-new']
}

Storybook <=5.2

在 Storybook 配置目录（默认情况下为 .storybook）中编辑或创建一个名为 addons.js 的文件。将以下内容添加到其中

import 'storybook-addon-whats-new';

入门

本地配置

要配置此插件，您必须提供一个 whatsNewSource 参数，其中包含要显示的 Markdown 文件的位置

import React from "react";
import { Button } from "./Button";
import WhatsNew from './WHATS_NEW.md';

export default {
  title: "Example/Button",
  component: Button,
  parameters: {
    whatsNewSource: WhatsNew,
  },
};

全局配置

如果希望在每个故事中显示“新增功能”面板，则可以在 .storybook/preview.js（对于 Storybook <= 5.2，则为 .storybook/config.js）中全局配置它。要配置此插件，您必须提供一个 whatsNewSource 参数，其中包含要显示的 Markdown 文件的位置

import { addParameters } from '@storybook/react'; // <- or your storybook framework
import WhatsNew from './WHATS_NEW.md';

addParameters({
  whatsNewSource: WhatsNew,
});