Storybook Addon Notes
Storybook Addon Notes allows you to write notes (text or HTML) for your stories in Storybook.
NOTE: Documentation on master branch is for alpha version, stable release is on master
yarn add -D @storybook/addon-notes
Then create a file called
addons.js in your Storybook config.
Add following content to it:
// register the notes addon as a tab;// or register the notes addon as a panel. Only one can be used!;
Now, you can use the
notes parameter to add a note to each story.
Using Markdown in your notes is supported, Storybook will load Markdown as raw by default.
When using Markdown, you can also embed gifs from Giphy into your Markdown. Currently, the value
gif of the gif prop is used to search and return the first result returned by Giphy.
# Title<Giphy gif='cheese' />