@storybook/addon-docs 7.0.0-alpha.18 → 7.0.0-alpha.20
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 +16 -16
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/main/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](https://github.com/storybookjs/storybook/
|
|
40
|
+
For more information on how it works, see the [`DocsPage` reference](https://github.com/storybookjs/storybook/blob/next/code/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/main/addons/docs/docs/media/mdx-simple.png" width="100%" />
|
|
74
74
|
</center>
|
|
75
75
|
|
|
76
|
-
For more information on `MDX`, see the [`MDX` reference](https://github.com/storybookjs/storybook/
|
|
76
|
+
For more information on `MDX`, see the [`MDX` reference](https://github.com/storybookjs/storybook/blob/next/code/addons/docs/docs/mdx.md).
|
|
77
77
|
|
|
78
78
|
## Framework support
|
|
79
79
|
|
|
@@ -83,7 +83,7 @@ Storybook Docs supports all view layers that Storybook supports except for React
|
|
|
83
83
|
|
|
84
84
|
**Note:** `#` = WIP support
|
|
85
85
|
|
|
86
|
-
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)
|
|
86
|
+
Want to add enhanced features to your favorite framework? Check out this [dev guide](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/docs/multiframework.md)
|
|
87
87
|
|
|
88
88
|
## Installation
|
|
89
89
|
|
|
@@ -108,7 +108,7 @@ module.exports = {
|
|
|
108
108
|
};
|
|
109
109
|
```
|
|
110
110
|
|
|
111
|
-
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
|
|
111
|
+
If using in conjunction with the [storyshots add-on](https://github.com/storybookjs/storybook/blob/next/code/addons/storyshots/storyshots-core/README.md), you will need to
|
|
112
112
|
configure Jest to transform MDX stories into something Storyshots can understand:
|
|
113
113
|
|
|
114
114
|
Add the following to your Jest configuration:
|
|
@@ -124,12 +124,12 @@ Add the following to your Jest configuration:
|
|
|
124
124
|
|
|
125
125
|
### Be sure to check framework specific installation needs
|
|
126
126
|
|
|
127
|
-
- [React](https://github.com/storybookjs/storybook/tree/next/addons/docs/react) (covered here)
|
|
128
|
-
- [Vue](https://github.com/storybookjs/storybook/tree/next/addons/docs/vue)
|
|
129
|
-
- [Angular](https://github.com/storybookjs/storybook/tree/next/addons/docs/angular)
|
|
130
|
-
- [Ember](https://github.com/storybookjs/storybook/tree/next/addons/docs/ember)
|
|
131
|
-
- [Web Components](https://github.com/storybookjs/storybook/tree/next/addons/docs/web-components)
|
|
132
|
-
- [Common setup (all other frameworks)](https://github.com/storybookjs/storybook/tree/next/addons/docs/common)
|
|
127
|
+
- [React](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/react) (covered here)
|
|
128
|
+
- [Vue](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/vue)
|
|
129
|
+
- [Angular](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/angular)
|
|
130
|
+
- [Ember](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/ember)
|
|
131
|
+
- [Web Components](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/web-components)
|
|
132
|
+
- [Common setup (all other frameworks)](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/common)
|
|
133
133
|
|
|
134
134
|
## Preset options
|
|
135
135
|
|
|
@@ -229,12 +229,12 @@ addParameters({
|
|
|
229
229
|
|
|
230
230
|
## TypeScript configuration
|
|
231
231
|
|
|
232
|
-
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).
|
|
232
|
+
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/code/addons/docs/docs/props-tables.md).
|
|
233
233
|
|
|
234
234
|
## More resources
|
|
235
235
|
|
|
236
236
|
Want to learn more? Here are some more articles on Storybook Docs:
|
|
237
237
|
|
|
238
|
-
- 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)
|
|
238
|
+
- References: [DocsPage](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/docs/docspage.md) / [MDX](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/docs/mdx.md) / [FAQ](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/docs/faq.md) / [Recipes](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/docs/recipes.md) / [Theming](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/docs/theming.md) / [Props](https://github.com/storybookjs/storybook/tree/next/code/addons/docs/docs/props-tables.md)
|
|
239
239
|
- 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)
|
|
240
240
|
- 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": "7.0.0-alpha.
|
|
3
|
+
"version": "7.0.0-alpha.20",
|
|
4
4
|
"description": "Document component usage and properties in Markdown",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"addon",
|
|
@@ -53,22 +53,22 @@
|
|
|
53
53
|
"@babel/preset-env": "^7.12.11",
|
|
54
54
|
"@jest/transform": "^26.6.2",
|
|
55
55
|
"@mdx-js/react": "^1.6.22",
|
|
56
|
-
"@storybook/addons": "7.0.0-alpha.
|
|
57
|
-
"@storybook/api": "7.0.0-alpha.
|
|
58
|
-
"@storybook/blocks": "7.0.0-alpha.
|
|
59
|
-
"@storybook/components": "7.0.0-alpha.
|
|
60
|
-
"@storybook/core-common": "7.0.0-alpha.
|
|
61
|
-
"@storybook/core-events": "7.0.0-alpha.
|
|
56
|
+
"@storybook/addons": "7.0.0-alpha.20",
|
|
57
|
+
"@storybook/api": "7.0.0-alpha.20",
|
|
58
|
+
"@storybook/blocks": "7.0.0-alpha.20",
|
|
59
|
+
"@storybook/components": "7.0.0-alpha.20",
|
|
60
|
+
"@storybook/core-common": "7.0.0-alpha.20",
|
|
61
|
+
"@storybook/core-events": "7.0.0-alpha.20",
|
|
62
62
|
"@storybook/csf": "0.0.2--canary.0899bb7.0",
|
|
63
|
-
"@storybook/csf-tools": "7.0.0-alpha.
|
|
64
|
-
"@storybook/docs-tools": "7.0.0-alpha.
|
|
63
|
+
"@storybook/csf-tools": "7.0.0-alpha.20",
|
|
64
|
+
"@storybook/docs-tools": "7.0.0-alpha.20",
|
|
65
65
|
"@storybook/mdx1-csf": "0.0.5-canary.13.9ce928a.0",
|
|
66
|
-
"@storybook/node-logger": "7.0.0-alpha.
|
|
67
|
-
"@storybook/postinstall": "7.0.0-alpha.
|
|
68
|
-
"@storybook/preview-web": "7.0.0-alpha.
|
|
69
|
-
"@storybook/source-loader": "7.0.0-alpha.
|
|
70
|
-
"@storybook/store": "7.0.0-alpha.
|
|
71
|
-
"@storybook/theming": "7.0.0-alpha.
|
|
66
|
+
"@storybook/node-logger": "7.0.0-alpha.20",
|
|
67
|
+
"@storybook/postinstall": "7.0.0-alpha.20",
|
|
68
|
+
"@storybook/preview-web": "7.0.0-alpha.20",
|
|
69
|
+
"@storybook/source-loader": "7.0.0-alpha.20",
|
|
70
|
+
"@storybook/store": "7.0.0-alpha.20",
|
|
71
|
+
"@storybook/theming": "7.0.0-alpha.20",
|
|
72
72
|
"babel-loader": "^8.2.5",
|
|
73
73
|
"core-js": "^3.8.2",
|
|
74
74
|
"dequal": "^2.0.2",
|
|
@@ -104,7 +104,7 @@
|
|
|
104
104
|
"publishConfig": {
|
|
105
105
|
"access": "public"
|
|
106
106
|
},
|
|
107
|
-
"gitHead": "
|
|
107
|
+
"gitHead": "a6c00d2ebed21da54b4772b4a4f7fed9258f0ab4",
|
|
108
108
|
"storybook": {
|
|
109
109
|
"displayName": "Docs",
|
|
110
110
|
"icon": "https://user-images.githubusercontent.com/263385/101991672-48355c80-3c7c-11eb-82d9-95fa12438f64.png",
|