Skip to content

Commit

Permalink
Fix bad markdown instructions (#6654)
Browse files Browse the repository at this point in the history
Fix bad markdown instructions
  • Loading branch information
shilman committed Apr 28, 2019
1 parent 262511b commit c901911
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions addons/notes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,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',
});
```

### With Vue
Expand All @@ -44,13 +43,16 @@ import { storiesOf } from '@storybook/vue';

import MyButton from './MyButton.vue';

storiesOf('MyButton', module)
.add('with some emoji', () => ({
storiesOf('MyButton', module).add(
'with some emoji',
() => ({
components: { MyButton },
template: '<my-button>😀 😎 👍 💯</my-button>'
}), {
template: '<my-button>😀 😎 👍 💯</my-button>',
}),
{
notes: 'A very simple example of addon notes',
});
}
);
```

## Using Markdown
Expand All @@ -60,10 +62,11 @@ Using Markdown in your notes is supported, Storybook will load Markdown as raw b
```js
import { storiesOf } from '@storybook/react';
import Component from './Component';
import notes from './someMarkdownText.md';
import markdownNotes from './someMarkdownText.md';

storiesOf('Component', module)
.add('With Markdown', () => <Component />, { notes });
storiesOf('Component', module).add('With Markdown', () => <Component />, {
notes: { markdown: markdownNotes },
});
```

## Giphy
Expand Down

0 comments on commit c901911

Please sign in to comment.