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

Update README: mention that addon-links needs to be registered manually #1835

Merged
merged 3 commits into from
Sep 12, 2017
Merged

Update README: mention that addon-links needs to be registered manually #1835

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
166bb5b
Update README.md: add hint that addon needs to be registered
mrtnpro Sep 12, 2017
9653424
fix typo
mrtnpro Sep 12, 2017
242cb8a
Update README.md
ndelangen Sep 12, 2017
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
13 changes: 12 additions & 1 deletion addons/links/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,18 @@ This addon works with Storybook for:

## Getting Started

You can use this addon without installing it.
Install this addon by adding the `@storybook/addon-links` dependency:
```sh
yarn add @storybook/addon-links
```

First configure it as an addon by adding it to your addons.js file (located in the Storybook config directory).

```js
import '@storybook/addon-links/register';
```

Then you can import `linkTo` in your stories and use like this:

```js
import { storiesOf } from '@storybook/react'
Expand Down