Skip to content

Latest commit

 

History

History
 
 

ondevice-notes

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

Storybook Notes Addon for react-native

The Notes Addon allows you to write notes (text or markdown) for your stories in Storybook.

Installation

yarn add -D @storybook/addon-ondevice-notes

Configuration

Then, add following content to .storybook/main.js:

module.exports = {
  addons: ['@storybook/addon-ondevice-notes'],
};

Usage

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.