Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Docs to use new Notes form and use yarn for addon install #3309

Merged
merged 3 commits into from
Mar 29, 2018
Merged

Update Docs to use new Notes form and use yarn for addon install #3309

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4501897
Update README.md to use yarn for install
paul42 Mar 28, 2018
4d1a80c
Update index.md
paul42 Mar 28, 2018
77801ae
Merge branch 'master' into master
Hypnosphi Mar 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion addons/notes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Storybook Addon Notes allows you to write notes (text or HTML) for your stories
### Getting Started

```sh
npm i --save-dev @storybook/addon-notes
yarn add -D @storybook/addon-notes
```

Then create a file called `addons.js` in your storybook config.
Expand Down
6 changes: 2 additions & 4 deletions docs/src/pages/addons/using-addons/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ We are going to use an addon called [Notes](https://github.com/storybooks/storyb
First, we need to install the addons:

```sh
npm i --save-dev @storybook/addons @storybook/addon-actions @storybook/addon-links @storybook/addon-notes
yarn add -D @storybook/addons @storybook/addon-actions @storybook/addon-links @storybook/addon-notes
```

Then, we need to create a file called `addons.js` inside the storybook config directory and add the following content:
Expand All @@ -38,9 +38,7 @@ import Button from './Button';

storiesOf('Button', module)
.add('with some emoji', () => (
<WithNotes notes={'Here we use some emoji as the Button text. Doesn&apos;t it look nice?'}>
<Button onClick={action('clicked')}><span role="img" aria-label="so cool">😀 😎 👍 💯</span></Button>
</WithNotes>
withNotes('A very simple component')(() => <Button onClick={action('clicked')}><span role="img" aria-label="so cool">😀 😎 👍 💯</span></Button>));
));
```

Expand Down