@storybook/addon-docs 7.0.0-beta.38 → 7.0.0-beta.39
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/angular/README.md +4 -4
- package/common/README.md +2 -2
- package/ember/README.md +2 -2
- package/package.json +12 -12
- package/react/README.md +3 -3
- package/vue/README.md +4 -4
package/README.md
CHANGED
|
@@ -99,9 +99,9 @@ yarn add -D react
|
|
|
99
99
|
Then add the following to your `.storybook/main.js`:
|
|
100
100
|
|
|
101
101
|
```js
|
|
102
|
-
|
|
102
|
+
export default {
|
|
103
103
|
stories: [
|
|
104
|
-
'../src/**/*.mdx
|
|
104
|
+
'../src/**/*.mdx', // 👈 Add this, to match your project's structure
|
|
105
105
|
'../src/**/*.stories.@(js|jsx|ts|tsx)',
|
|
106
106
|
],
|
|
107
107
|
addons: [
|
|
@@ -138,7 +138,7 @@ Add the following to your Jest configuration:
|
|
|
138
138
|
The `addon-docs` preset has a few configuration options that can be used to configure its babel/webpack loading behavior. Here's an example of how to use the preset with options:
|
|
139
139
|
|
|
140
140
|
```js
|
|
141
|
-
|
|
141
|
+
export default {
|
|
142
142
|
addons: [
|
|
143
143
|
{
|
|
144
144
|
name: '@storybook/addon-docs',
|
package/angular/README.md
CHANGED
|
@@ -31,7 +31,7 @@ yarn add -D @storybook/addon-docs@next
|
|
|
31
31
|
Then add the following to your `.storybook/main.js` exports:
|
|
32
32
|
|
|
33
33
|
```js
|
|
34
|
-
|
|
34
|
+
export default {
|
|
35
35
|
addons: ['@storybook/addon-docs'],
|
|
36
36
|
};
|
|
37
37
|
```
|
|
@@ -135,9 +135,9 @@ yarn add -D react
|
|
|
135
135
|
|
|
136
136
|
Then update your `.storybook/main.js` to make sure you load MDX files:
|
|
137
137
|
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
stories: ['../src
|
|
138
|
+
```js
|
|
139
|
+
export default {
|
|
140
|
+
stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|ts|tsx)'],
|
|
141
141
|
};
|
|
142
142
|
```
|
|
143
143
|
|
package/common/README.md
CHANGED
|
@@ -21,7 +21,7 @@ yarn add -D @storybook/addon-docs@next
|
|
|
21
21
|
Then add the following to your `.storybook/main.js` addons:
|
|
22
22
|
|
|
23
23
|
```js
|
|
24
|
-
|
|
24
|
+
export default {
|
|
25
25
|
addons: ['@storybook/addon-docs'],
|
|
26
26
|
};
|
|
27
27
|
```
|
|
@@ -43,7 +43,7 @@ yarn add -D react
|
|
|
43
43
|
Then update your `.storybook/main.js` to make sure you load MDX files:
|
|
44
44
|
|
|
45
45
|
```js
|
|
46
|
-
|
|
46
|
+
export default {
|
|
47
47
|
stories: ['../src/stories/**/*.stories.@(js|mdx)'],
|
|
48
48
|
};
|
|
49
49
|
```
|
package/ember/README.md
CHANGED
|
@@ -24,7 +24,7 @@ yarn add -D @storybook/addon-docs@next
|
|
|
24
24
|
Then add the following to your `.storybook/main.js` addons:
|
|
25
25
|
|
|
26
26
|
```js
|
|
27
|
-
|
|
27
|
+
export default {
|
|
28
28
|
addons: ['@storybook/addon-docs'],
|
|
29
29
|
};
|
|
30
30
|
```
|
|
@@ -87,7 +87,7 @@ yarn add -D react
|
|
|
87
87
|
Then update your `.storybook/main.js` to make sure you load MDX files:
|
|
88
88
|
|
|
89
89
|
```js
|
|
90
|
-
|
|
90
|
+
export default {
|
|
91
91
|
stories: ['../src/stories/**/*.stories.@(js|mdx)'],
|
|
92
92
|
};
|
|
93
93
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@storybook/addon-docs",
|
|
3
|
-
"version": "7.0.0-beta.
|
|
3
|
+
"version": "7.0.0-beta.39",
|
|
4
4
|
"description": "Document component usage and properties in Markdown",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"addon",
|
|
@@ -103,18 +103,18 @@
|
|
|
103
103
|
"@babel/plugin-transform-react-jsx": "^7.19.0",
|
|
104
104
|
"@jest/transform": "^29.3.1",
|
|
105
105
|
"@mdx-js/react": "^2.1.5",
|
|
106
|
-
"@storybook/blocks": "7.0.0-beta.
|
|
107
|
-
"@storybook/client-logger": "7.0.0-beta.
|
|
108
|
-
"@storybook/components": "7.0.0-beta.
|
|
109
|
-
"@storybook/csf-plugin": "7.0.0-beta.
|
|
110
|
-
"@storybook/csf-tools": "7.0.0-beta.
|
|
106
|
+
"@storybook/blocks": "7.0.0-beta.39",
|
|
107
|
+
"@storybook/client-logger": "7.0.0-beta.39",
|
|
108
|
+
"@storybook/components": "7.0.0-beta.39",
|
|
109
|
+
"@storybook/csf-plugin": "7.0.0-beta.39",
|
|
110
|
+
"@storybook/csf-tools": "7.0.0-beta.39",
|
|
111
111
|
"@storybook/global": "^5.0.0",
|
|
112
112
|
"@storybook/mdx2-csf": "next",
|
|
113
|
-
"@storybook/node-logger": "7.0.0-beta.
|
|
114
|
-
"@storybook/postinstall": "7.0.0-beta.
|
|
115
|
-
"@storybook/preview-api": "7.0.0-beta.
|
|
116
|
-
"@storybook/theming": "7.0.0-beta.
|
|
117
|
-
"@storybook/types": "7.0.0-beta.
|
|
113
|
+
"@storybook/node-logger": "7.0.0-beta.39",
|
|
114
|
+
"@storybook/postinstall": "7.0.0-beta.39",
|
|
115
|
+
"@storybook/preview-api": "7.0.0-beta.39",
|
|
116
|
+
"@storybook/theming": "7.0.0-beta.39",
|
|
117
|
+
"@storybook/types": "7.0.0-beta.39",
|
|
118
118
|
"fs-extra": "^11.1.0",
|
|
119
119
|
"remark-external-links": "^8.0.0",
|
|
120
120
|
"remark-slug": "^6.0.0",
|
|
@@ -147,7 +147,7 @@
|
|
|
147
147
|
"./src/shims/mdx-react-shim.ts"
|
|
148
148
|
]
|
|
149
149
|
},
|
|
150
|
-
"gitHead": "
|
|
150
|
+
"gitHead": "96d484511811e3154ff18c55814a1f4688946335",
|
|
151
151
|
"storybook": {
|
|
152
152
|
"displayName": "Docs",
|
|
153
153
|
"icon": "https://user-images.githubusercontent.com/263385/101991672-48355c80-3c7c-11eb-82d9-95fa12438f64.png",
|
package/react/README.md
CHANGED
|
@@ -29,7 +29,7 @@ yarn add -D @storybook/addon-docs@next
|
|
|
29
29
|
Then add the following to your `.storybook/main.js` list of `addons`:
|
|
30
30
|
|
|
31
31
|
```js
|
|
32
|
-
|
|
32
|
+
export default {
|
|
33
33
|
// other settings
|
|
34
34
|
addons: ['@storybook/addon-docs'];
|
|
35
35
|
}
|
|
@@ -70,7 +70,7 @@ storiesOf('InfoButton', module)
|
|
|
70
70
|
Then update your `.storybook/main.js` to make sure you load MDX files:
|
|
71
71
|
|
|
72
72
|
```js
|
|
73
|
-
|
|
73
|
+
export default {
|
|
74
74
|
stories: ['../src/stories/**/*.stories.@(js|mdx)'],
|
|
75
75
|
};
|
|
76
76
|
```
|
|
@@ -115,7 +115,7 @@ If you're using TypeScript, there are two different options for generating props
|
|
|
115
115
|
You can add the following lines to your `.storybook/main.js` to switch between the two (or disable docgen):
|
|
116
116
|
|
|
117
117
|
```js
|
|
118
|
-
|
|
118
|
+
export default {
|
|
119
119
|
typescript: {
|
|
120
120
|
// also valid 'react-docgen-typescript' | false
|
|
121
121
|
reactDocgen: 'react-docgen',
|
package/vue/README.md
CHANGED
|
@@ -29,7 +29,7 @@ yarn add -D @storybook/addon-docs@next
|
|
|
29
29
|
Then add the following to your `.storybook/main.js` addons:
|
|
30
30
|
|
|
31
31
|
```js
|
|
32
|
-
|
|
32
|
+
export default {
|
|
33
33
|
addons: ['@storybook/addon-docs'],
|
|
34
34
|
};
|
|
35
35
|
```
|
|
@@ -39,9 +39,9 @@ module.exports = {
|
|
|
39
39
|
The `addon-docs` preset for Vue has a configuration option that can be used to configure [`vue-docgen-api`](https://github.com/vue-styleguidist/vue-styleguidist/tree/dev/packages/vue-docgen-api), a tool which extracts information from Vue components. Here's an example of how to use the preset with options for Vue app:
|
|
40
40
|
|
|
41
41
|
```js
|
|
42
|
-
|
|
42
|
+
import * as path from 'path';
|
|
43
43
|
|
|
44
|
-
|
|
44
|
+
export default {
|
|
45
45
|
addons: [
|
|
46
46
|
{
|
|
47
47
|
name: '@storybook/addon-docs',
|
|
@@ -102,7 +102,7 @@ yarn add -D react
|
|
|
102
102
|
Then update your `.storybook/main.js` to make sure you load MDX files:
|
|
103
103
|
|
|
104
104
|
```js
|
|
105
|
-
|
|
105
|
+
export default {
|
|
106
106
|
stories: ['../src/stories/**/*.stories.@(js|mdx)'],
|
|
107
107
|
};
|
|
108
108
|
```
|