GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-06 00:41:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Andrew Lisowski 2019-03-14 11:11:24 -07:00
parent d0b324211c
commit f16d94c60b
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
addons/notes/README.md
View File

@ -19,7 +19,10 @@ Then create a file called `addons.js` in your storybook config.
Add following content to it:
```js
// register the notes addon as a tab
import '@storybook/addon-notes/register';
// register the notes addon as a panel
import '@storybook/addon-notes/register-panel';
```
You can use the `notes` parameter to add a note to each story:
@ -29,10 +32,9 @@ import { storiesOf } from '@storybook/react';
import Component from './Component';
storiesOf('Component', module)
.add('with some emoji', () => <Component />, {
notes: 'A very simple example of addon notes',
});
storiesOf('Component', module).add('with some emoji', () => <Component />, {
notes: 'A very simple example of addon notes',
});
```
#### Using Markdown
@ -44,8 +46,7 @@ import { storiesOf } from '@storybook/react';
import Component from './Component';
import notes from './someMarkdownText.md';
storiesOf('Component', module)
.add('With Markdown', () => <Component />, { notes });
storiesOf('Component', module).add('With Markdown', () => <Component />, { notes });
```
### Giphy
@ -57,4 +58,3 @@ When using markdown, you can also embed gifs from Giphy into your markdown. Curr
<Giphy gif='cheese' />
```