@storybook/addon-docs 6.1.20 → 6.1.21
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 +12 -12
- package/package.json +17 -17
package/README.md
CHANGED
|
@@ -37,7 +37,7 @@ Click on the `Docs` tab to see it:
|
|
|
37
37
|
<img src="https://raw.githubusercontent.com/storybookjs/storybook/master/addons/docs/docs/media/docs-tab.png" width="100%" />
|
|
38
38
|
</center>
|
|
39
39
|
|
|
40
|
-
For more information on how it works, see the [`DocsPage` reference](
|
|
40
|
+
For more information on how it works, see the [`DocsPage` reference](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/docspage.md).
|
|
41
41
|
|
|
42
42
|
## MDX
|
|
43
43
|
|
|
@@ -73,7 +73,7 @@ And here's how that's rendered in Storybook:
|
|
|
73
73
|
<img src="https://raw.githubusercontent.com/storybookjs/storybook/master/addons/docs/docs/media/mdx-simple.png" width="100%" />
|
|
74
74
|
</center>
|
|
75
75
|
|
|
76
|
-
For more information on `MDX`, see the [`MDX` reference](
|
|
76
|
+
For more information on `MDX`, see the [`MDX` reference](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/mdx.md).
|
|
77
77
|
|
|
78
78
|
## Framework support
|
|
79
79
|
|
|
@@ -93,7 +93,7 @@ Storybook Docs supports all view layers that Storybook supports except for React
|
|
|
93
93
|
|
|
94
94
|
**Note:** `#` = WIP support
|
|
95
95
|
|
|
96
|
-
Want to add enhanced features to your favorite framework? Check out this [dev guide](
|
|
96
|
+
Want to add enhanced features to your favorite framework? Check out this [dev guide](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/multiframework.md)
|
|
97
97
|
|
|
98
98
|
## Installation
|
|
99
99
|
|
|
@@ -118,7 +118,7 @@ module.exports = {
|
|
|
118
118
|
};
|
|
119
119
|
```
|
|
120
120
|
|
|
121
|
-
If using in conjunction with the [storyshots add-on](
|
|
121
|
+
If using in conjunction with the [storyshots add-on](https://github.com/storybookjs/storybook/blob/next/addons/storyshots/storyshots-core/README.md), you will need to
|
|
122
122
|
configure Jest to transform MDX stories into something Storyshots can understand:
|
|
123
123
|
|
|
124
124
|
Add the following to your Jest configuration:
|
|
@@ -134,12 +134,12 @@ Add the following to your Jest configuration:
|
|
|
134
134
|
|
|
135
135
|
### Be sure to check framework specific installation needs
|
|
136
136
|
|
|
137
|
-
- [React](
|
|
138
|
-
- [Vue](
|
|
139
|
-
- [Angular](
|
|
140
|
-
- [Ember](
|
|
141
|
-
- [Web Components](
|
|
142
|
-
- [Common setup (all other frameworks)](
|
|
137
|
+
- [React](https://github.com/storybookjs/storybook/tree/next/addons/docs/react) (covered here)
|
|
138
|
+
- [Vue](https://github.com/storybookjs/storybook/tree/next/addons/docs/vue)
|
|
139
|
+
- [Angular](https://github.com/storybookjs/storybook/tree/next/addons/docs/angular)
|
|
140
|
+
- [Ember](https://github.com/storybookjs/storybook/tree/next/addons/docs/ember)
|
|
141
|
+
- [Web Components](https://github.com/storybookjs/storybook/tree/next/addons/docs/web-components)
|
|
142
|
+
- [Common setup (all other frameworks)](https://github.com/storybookjs/storybook/tree/next/addons/docs/common)
|
|
143
143
|
|
|
144
144
|
## Preset options
|
|
145
145
|
|
|
@@ -226,12 +226,12 @@ addParameters({
|
|
|
226
226
|
|
|
227
227
|
## TypeScript configuration
|
|
228
228
|
|
|
229
|
-
As of SB6 [TypeScript is zero-config](https://storybook.js.org/docs/react/configure/typescript) and should work with SB Docs out of the box. For advanced configuration options, refer to the [Props documentation](
|
|
229
|
+
As of SB6 [TypeScript is zero-config](https://storybook.js.org/docs/react/configure/typescript) and should work with SB Docs out of the box. For advanced configuration options, refer to the [Props documentation](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/props-tables.md).
|
|
230
230
|
|
|
231
231
|
## More resources
|
|
232
232
|
|
|
233
233
|
Want to learn more? Here are some more articles on Storybook Docs:
|
|
234
234
|
|
|
235
|
-
- References: [DocsPage](
|
|
235
|
+
- References: [DocsPage](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/docspage.md) / [MDX](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/mdx.md) / [FAQ](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/faq.md) / [Recipes](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/recipes.md) / [Theming](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/theming.md) / [Props](https://github.com/storybookjs/storybook/tree/next/addons/docs/docs/props-tables.md)
|
|
236
236
|
- Announcements: [Vision](https://medium.com/storybookjs/storybook-docs-sneak-peak-5be78445094a) / [DocsPage](https://medium.com/storybookjs/storybook-docspage-e185bc3622bf) / [MDX](https://medium.com/storybookjs/rich-docs-with-storybook-mdx-61bc145ae7bc) / [Framework support](https://medium.com/storybookjs/storybook-docs-for-new-frameworks-b1f6090ee0ea)
|
|
237
237
|
- Example: [Storybook Design System](https://github.com/storybookjs/design-system)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@storybook/addon-docs",
|
|
3
|
-
"version": "6.1.
|
|
3
|
+
"version": "6.1.21",
|
|
4
4
|
"description": "Document component usage and properties in Markdown",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"addon",
|
|
@@ -48,18 +48,18 @@
|
|
|
48
48
|
"@mdx-js/loader": "^1.6.19",
|
|
49
49
|
"@mdx-js/mdx": "^1.6.19",
|
|
50
50
|
"@mdx-js/react": "^1.6.19",
|
|
51
|
-
"@storybook/addons": "6.1.
|
|
52
|
-
"@storybook/api": "6.1.
|
|
53
|
-
"@storybook/client-api": "6.1.
|
|
54
|
-
"@storybook/client-logger": "6.1.
|
|
55
|
-
"@storybook/components": "6.1.
|
|
56
|
-
"@storybook/core": "6.1.
|
|
57
|
-
"@storybook/core-events": "6.1.
|
|
51
|
+
"@storybook/addons": "6.1.21",
|
|
52
|
+
"@storybook/api": "6.1.21",
|
|
53
|
+
"@storybook/client-api": "6.1.21",
|
|
54
|
+
"@storybook/client-logger": "6.1.21",
|
|
55
|
+
"@storybook/components": "6.1.21",
|
|
56
|
+
"@storybook/core": "6.1.21",
|
|
57
|
+
"@storybook/core-events": "6.1.21",
|
|
58
58
|
"@storybook/csf": "0.0.1",
|
|
59
|
-
"@storybook/node-logger": "6.1.
|
|
60
|
-
"@storybook/postinstall": "6.1.
|
|
61
|
-
"@storybook/source-loader": "6.1.
|
|
62
|
-
"@storybook/theming": "6.1.
|
|
59
|
+
"@storybook/node-logger": "6.1.21",
|
|
60
|
+
"@storybook/postinstall": "6.1.21",
|
|
61
|
+
"@storybook/source-loader": "6.1.21",
|
|
62
|
+
"@storybook/theming": "6.1.21",
|
|
63
63
|
"acorn": "^7.1.0",
|
|
64
64
|
"acorn-jsx": "^5.1.0",
|
|
65
65
|
"acorn-walk": "^7.0.0",
|
|
@@ -84,9 +84,9 @@
|
|
|
84
84
|
"@angular/core": "^11.0.0",
|
|
85
85
|
"@emotion/core": "^10.1.1",
|
|
86
86
|
"@emotion/styled": "^10.0.23",
|
|
87
|
-
"@storybook/react": "6.1.
|
|
88
|
-
"@storybook/vue": "6.1.
|
|
89
|
-
"@storybook/web-components": "6.1.
|
|
87
|
+
"@storybook/react": "6.1.21",
|
|
88
|
+
"@storybook/vue": "6.1.21",
|
|
89
|
+
"@storybook/web-components": "6.1.21",
|
|
90
90
|
"@types/cross-spawn": "^6.0.1",
|
|
91
91
|
"@types/doctrine": "^0.0.3",
|
|
92
92
|
"@types/enzyme": "^3.10.3",
|
|
@@ -115,7 +115,7 @@
|
|
|
115
115
|
},
|
|
116
116
|
"peerDependencies": {
|
|
117
117
|
"@babel/core": "^7.11.5",
|
|
118
|
-
"@storybook/vue": "6.1.
|
|
118
|
+
"@storybook/vue": "6.1.21",
|
|
119
119
|
"babel-loader": "^8.0.0",
|
|
120
120
|
"react": "^16.8.0 || ^17.0.0",
|
|
121
121
|
"react-dom": "^16.8.0 || ^17.0.0",
|
|
@@ -146,7 +146,7 @@
|
|
|
146
146
|
"publishConfig": {
|
|
147
147
|
"access": "public"
|
|
148
148
|
},
|
|
149
|
-
"gitHead": "
|
|
149
|
+
"gitHead": "bd1d47e5778d40acbba8fba7ed11c46f9c995273",
|
|
150
150
|
"typesVersions": {
|
|
151
151
|
"<3.8": {
|
|
152
152
|
"*": [
|