storybook-addon-description

Storybook Addon description

Add description to panel

Installation

First, install the package.

npm install --save-dev storybook-addon-description

Then, register it as an addon in .storybook/main.js.

// .storybook/main.ts

// Replace your-framework with the framework you are using (e.g., react-webpack5, vue3-vite)
import type { StorybookConfig } from '@storybook/your-framework';

const config: StorybookConfig = {
  // ...rest of config
  addons: [
    '@storybook/addon-essentials',
    'storybook-addon-description', // 👈 register the addon here
  ],
};

export default config;

Usage

The primary way to use this addon is to define the description parameter. You can do this the single story, as below.

// Button.stories.ts

// Replace your-framework with the name of your framework
import type { Meta } from '@storybook/your-framework';

import { Button } from './Button';

const meta: Meta<typeof Button> = {
  component: Button,
};

export default meta;

export const Primary: Story = {
  // More on args: https://storybook.js.org/docs/react/writing-stories/args
  args: {
    primary: true,
    label: "Button"
  },
  parameters: { description: `
# GFM

## Autolink literals

www.example.com, https://example.com, and contact@example.com.

## Footnote

A note[^1]

[^1]: https://github.com/imsokoloviv/addon-description/blob/HEAD/Big note.

## Strikethrough

~one~ or ~~two~~ tildes.

## Table

| a | b  |  c |  d  |
| - | :- | -: | :-: |

## Tasklist

* [ ] to do
* [x] done
` }
};

However, but default Storybook supports individual stories for components so it will automatically fallback to the Storybook docs values if a description parameter is not found.