The Notes Addon allows you to write notes (text or markdown) for your stories in Storybook.
yarn add -D @storybook/addon-ondevice-notes
Then, add following content to .storybook/main.js
:
module.exports = {
addons: ['@storybook/addon-ondevice-notes'],
};
Use the notes
parameter to add a note to stories:
export default {
title: 'My title',
component: MyComponent,
parameters: {
notes: `
# Here I can add some markdown
Put a full new line between each element.
`,
},
};
See the example app for more examples.