Storybook 擴充功能變更日誌檢視器

在 Storybook UI 中顯示變更日誌檔案 - 由 ❤️ Dave Bitter 製作

需要 Storybook v7.0.0 或更高版本才能使用此擴充功能

用法

1. 安裝擴充功能

   npm install storybook-addon-changelog-viewer --save
   

   yarn add storybook-addon-changelog-viewer --save
   

2. 在 .storybook/main.js 中載入擴充功能

   module.exports = {
     // other configuration here
     addons: [
       // other addons here.
       "storybook-addon-changelog-viewer",
     ],
   };
   

3. 在 story 中匯入變更日誌檔案，並將其傳遞給 changelog 參數

   import changelog from "./CHANGELOG.md";
   
   export default {
     title: "Your Component",
     parameters: {
       changelog: changelog,
     },
   };
   

4. 在 Storybook UI 中檢視變更日誌。應該會有一個名為「Changelog」的新標籤

功能

• 在 Storybook UI 中檢視變更日誌檔案
• 將 Markdown 渲染為 HTML
• 自動產生一個導覽，其中包含所有具有 SemVer 字串的標題連結（例如「## 1.0.0 - 2022-06-30」）

動機

建立此擴充功能是為了讓在 Storybook UI 中檢視變更日誌檔案更容易。由於 Storybook v7.0.0。Storybook Addon Notes 不再運作，這就是建立此擴充功能的原因。