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

Update the examples of handling markdown in notes addon

Browse Source
This commit is contained in:
Keraito 2018-04-30 17:53:39 +02:00
parent 9740215349
commit dc1d195ae4
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
addons/notes/README.md
View File

@ -52,7 +52,7 @@ storiesOf('Component', module)
#### Using Markdown
To use markdown in your notes simply import a markdown file and use that in your note.
To use markdown in your notes simply import a markdown file and use that in the `markdown` property of your note.
```js
import { storiesOf } from '@storybook/react';
@ -62,11 +62,11 @@ import someMarkdownText from './someMarkdownText.md';
storiesOf('Component', module).add(
'With Markdown',
() => <Component />
{ notes: someMarkdownText }
{ notes: { markdown: someMarkdownText } }
);
```
If you want to use Github flavored markdown inline, use `notes: { markdownText: 'your md' }`:
Similarly, if you want to use Github flavored markdown inline, use `notes: { markdownText: 'your md' }`:
```js
import { storiesOf } from '@storybook/react';

4
examples/official-storybook/stories/addon-notes.stories.js
View File

@ -32,7 +32,9 @@ storiesOf('Addons|Notes', module)
notes:
'This is the notes for a button. This is helpful for adding details about a story in a separate panel.',
})
.add('withNotes rendering imported markdown', baseStory, { notes: markdownNotes })
.add('withNotes rendering imported markdown', baseStory, {
notes: { markdown: markdownNotes },
})
.add('withNotes rendering inline, github-flavored markdown', baseStory, {
notes: { markdown: markdownString },
})