Skip to content

Commit b1edd5f

Browse files
authored
Merge pull request #3 from kemuridama/v1.0.0
Release v1.0.0
2 parents 3c7c313 + 5dbe529 commit b1edd5f

File tree

3 files changed

+124
-135
lines changed

3 files changed

+124
-135
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,33 @@
11
# storybook-addon-github
22

33
A Storybook addon that allows you to link a source code of your story on GitHub.
4+
5+
## Installation
6+
7+
```
8+
npm i -D @kemuridama/storybook-addon-github
9+
```
10+
11+
## Configuration
12+
13+
Add the following to your `.storybook/main.js`:
14+
15+
```
16+
export default {
17+
addons: ['@kemuridama/storybook-addon-github'],
18+
}
19+
```
20+
21+
Then, add the following to your `.storybook/preview.js`:
22+
23+
```
24+
export default {
25+
parameters: {
26+
github: {
27+
baseURL: "<GitHub Enterprise Server URL (optional)>",
28+
repository: "<repository name>",
29+
branch: "<branch name>",
30+
}
31+
}
32+
}
33+
```

0 commit comments

Comments
 (0)