@storybook/addon-docs 7.0.2 → 7.0.3
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 +1 -1
- package/angular/README.md +1 -1
- package/common/README.md +1 -1
- package/dist/preview.js +1 -1
- package/dist/preview.mjs +1 -1
- package/ember/README.md +1 -1
- package/package.json +13 -13
- package/react/README.md +1 -1
- package/vue/README.md +1 -1
package/README.md
CHANGED
|
@@ -110,7 +110,7 @@ export default {
|
|
|
110
110
|
};
|
|
111
111
|
```
|
|
112
112
|
|
|
113
|
-
If using in conjunction with the [storyshots add-on](https://github.com/storybookjs/storybook/blob/next/code/addons/storyshots
|
|
113
|
+
If using in conjunction with the [storyshots add-on](https://github.com/storybookjs/storybook/blob/next/code/addons/storyshots-core/README.md), you will need to
|
|
114
114
|
configure Jest to transform MDX stories into something Storyshots can understand:
|
|
115
115
|
|
|
116
116
|
Add the following to your Jest configuration:
|
package/angular/README.md
CHANGED
|
@@ -25,7 +25,7 @@ To learn more about Storybook Docs, read the [general documentation](../README.m
|
|
|
25
25
|
First add the package. Make sure that the versions for your `@storybook/*` packages match:
|
|
26
26
|
|
|
27
27
|
```sh
|
|
28
|
-
yarn add -D @storybook/addon-docs
|
|
28
|
+
yarn add -D @storybook/addon-docs
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
Then add the following to your `.storybook/main.js` exports:
|
package/common/README.md
CHANGED
|
@@ -15,7 +15,7 @@ Popular frameworks like [React](../react/README.md)/[Vue](../vue/README.md)/[Ang
|
|
|
15
15
|
First add the package. Make sure that the versions for your `@storybook/*` packages match:
|
|
16
16
|
|
|
17
17
|
```sh
|
|
18
|
-
yarn add -D @storybook/addon-docs
|
|
18
|
+
yarn add -D @storybook/addon-docs
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
Then add the following to your `.storybook/main.js` addons:
|
package/dist/preview.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty;var __esm=(fn,res)=>function(){return fn&&(res=(0,fn[__getOwnPropNames(fn)[0]])(fn=0)),res};var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0})},__copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to};var __toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var DocsRenderer_exports={};__export(DocsRenderer_exports,{DocsRenderer:()=>DocsRenderer,defaultComponents:()=>defaultComponents});var import_react,import_react_dom_shim,import_blocks,defaultComponents,ErrorBoundary,DocsRenderer,init_DocsRenderer=__esm({"src/DocsRenderer.tsx"(){import_react=__toESM(require("react")),import_react_dom_shim=require("@storybook/react-dom-shim"),import_blocks=require("@storybook/blocks"),defaultComponents={code:import_blocks.CodeOrSourceMdx,a:import_blocks.AnchorMdx,...import_blocks.HeadersMdx},ErrorBoundary=class extends import_react.Component{constructor(){super(...arguments);this.state={hasError:!1}}static getDerivedStateFromError(){return{hasError:!0}}componentDidCatch(err){let{showException}=this.props;showException(err)}render(){let{hasError}=this.state,{children}=this.props;return hasError?null:children}},DocsRenderer=class{constructor(){this.render=async(context,docsParameter,element)=>{let components={...defaultComponents,...docsParameter==null?void 0:docsParameter.components};return new Promise((resolve,reject)=>{import("@mdx-js/react").then(({MDXProvider})=>(0,import_react_dom_shim.renderElement)(import_react.default.createElement(ErrorBoundary,{showException:reject,key:Math.random()},import_react.default.createElement(MDXProvider,{components},import_react.default.createElement(import_blocks.Docs,{context,docsParameter}))),element)).then(resolve)})},this.unmount=element=>{(0,import_react_dom_shim.unmountElement)(element)}}}}});var preview_exports={};__export(preview_exports,{parameters:()=>parameters});module.exports=__toCommonJS(preview_exports);var parameters={docs:{renderer:async()=>{let{DocsRenderer:DocsRenderer2}=await Promise.resolve().then(()=>(init_DocsRenderer(),DocsRenderer_exports));return new DocsRenderer2}
|
|
1
|
+
var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty;var __esm=(fn,res)=>function(){return fn&&(res=(0,fn[__getOwnPropNames(fn)[0]])(fn=0)),res};var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0})},__copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to};var __toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var DocsRenderer_exports={};__export(DocsRenderer_exports,{DocsRenderer:()=>DocsRenderer,defaultComponents:()=>defaultComponents});var import_react,import_react_dom_shim,import_blocks,defaultComponents,ErrorBoundary,DocsRenderer,init_DocsRenderer=__esm({"src/DocsRenderer.tsx"(){import_react=__toESM(require("react")),import_react_dom_shim=require("@storybook/react-dom-shim"),import_blocks=require("@storybook/blocks"),defaultComponents={code:import_blocks.CodeOrSourceMdx,a:import_blocks.AnchorMdx,...import_blocks.HeadersMdx},ErrorBoundary=class extends import_react.Component{constructor(){super(...arguments);this.state={hasError:!1}}static getDerivedStateFromError(){return{hasError:!0}}componentDidCatch(err){let{showException}=this.props;showException(err)}render(){let{hasError}=this.state,{children}=this.props;return hasError?null:children}},DocsRenderer=class{constructor(){this.render=async(context,docsParameter,element)=>{let components={...defaultComponents,...docsParameter==null?void 0:docsParameter.components};return new Promise((resolve,reject)=>{import("@mdx-js/react").then(({MDXProvider})=>(0,import_react_dom_shim.renderElement)(import_react.default.createElement(ErrorBoundary,{showException:reject,key:Math.random()},import_react.default.createElement(MDXProvider,{components},import_react.default.createElement(import_blocks.Docs,{context,docsParameter}))),element)).then(resolve)})},this.unmount=element=>{(0,import_react_dom_shim.unmountElement)(element)}}}}});var preview_exports={};__export(preview_exports,{parameters:()=>parameters});module.exports=__toCommonJS(preview_exports);var parameters={docs:{renderer:async()=>{let{DocsRenderer:DocsRenderer2}=await Promise.resolve().then(()=>(init_DocsRenderer(),DocsRenderer_exports));return new DocsRenderer2}}};0&&(module.exports={parameters});
|
package/dist/preview.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import"./chunk-R4NKYYJA.mjs";var parameters={docs:{renderer:async()=>{let{DocsRenderer}=await import("./DocsRenderer-7FRJXR4N.mjs");return new DocsRenderer}
|
|
1
|
+
import"./chunk-R4NKYYJA.mjs";var parameters={docs:{renderer:async()=>{let{DocsRenderer}=await import("./DocsRenderer-7FRJXR4N.mjs");return new DocsRenderer}}};export{parameters};
|
package/ember/README.md
CHANGED
|
@@ -18,7 +18,7 @@ To learn more about Storybook Docs, read the [general documentation](../README.m
|
|
|
18
18
|
First add the package. Make sure that the versions for your `@storybook/*` packages match:
|
|
19
19
|
|
|
20
20
|
```sh
|
|
21
|
-
yarn add -D @storybook/addon-docs
|
|
21
|
+
yarn add -D @storybook/addon-docs
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
Then add the following to your `.storybook/main.js` addons:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@storybook/addon-docs",
|
|
3
|
-
"version": "7.0.
|
|
3
|
+
"version": "7.0.3",
|
|
4
4
|
"description": "Document component usage and properties in Markdown",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"addon",
|
|
@@ -103,19 +103,19 @@
|
|
|
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.
|
|
107
|
-
"@storybook/client-logger": "7.0.
|
|
108
|
-
"@storybook/components": "7.0.
|
|
109
|
-
"@storybook/csf-plugin": "7.0.
|
|
110
|
-
"@storybook/csf-tools": "7.0.
|
|
106
|
+
"@storybook/blocks": "7.0.3",
|
|
107
|
+
"@storybook/client-logger": "7.0.3",
|
|
108
|
+
"@storybook/components": "7.0.3",
|
|
109
|
+
"@storybook/csf-plugin": "7.0.3",
|
|
110
|
+
"@storybook/csf-tools": "7.0.3",
|
|
111
111
|
"@storybook/global": "^5.0.0",
|
|
112
112
|
"@storybook/mdx2-csf": "^1.0.0",
|
|
113
|
-
"@storybook/node-logger": "7.0.
|
|
114
|
-
"@storybook/postinstall": "7.0.
|
|
115
|
-
"@storybook/preview-api": "7.0.
|
|
116
|
-
"@storybook/react-dom-shim": "7.0.
|
|
117
|
-
"@storybook/theming": "7.0.
|
|
118
|
-
"@storybook/types": "7.0.
|
|
113
|
+
"@storybook/node-logger": "7.0.3",
|
|
114
|
+
"@storybook/postinstall": "7.0.3",
|
|
115
|
+
"@storybook/preview-api": "7.0.3",
|
|
116
|
+
"@storybook/react-dom-shim": "7.0.3",
|
|
117
|
+
"@storybook/theming": "7.0.3",
|
|
118
|
+
"@storybook/types": "7.0.3",
|
|
119
119
|
"fs-extra": "^11.1.0",
|
|
120
120
|
"remark-external-links": "^8.0.0",
|
|
121
121
|
"remark-slug": "^6.0.0",
|
|
@@ -148,7 +148,7 @@
|
|
|
148
148
|
"./src/shims/mdx-react-shim.ts"
|
|
149
149
|
]
|
|
150
150
|
},
|
|
151
|
-
"gitHead": "
|
|
151
|
+
"gitHead": "71877c1f4ba6b2d8829adc200a9c4bb09f7bfc37",
|
|
152
152
|
"storybook": {
|
|
153
153
|
"displayName": "Docs",
|
|
154
154
|
"icon": "https://user-images.githubusercontent.com/263385/101991672-48355c80-3c7c-11eb-82d9-95fa12438f64.png",
|
package/react/README.md
CHANGED
|
@@ -23,7 +23,7 @@ To learn more about Storybook Docs, read the [general documentation](../README.m
|
|
|
23
23
|
First add the package. Make sure that the versions for your `@storybook/*` packages match:
|
|
24
24
|
|
|
25
25
|
```sh
|
|
26
|
-
yarn add -D @storybook/addon-docs
|
|
26
|
+
yarn add -D @storybook/addon-docs
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
Then add the following to your `.storybook/main.js` list of `addons`:
|
package/vue/README.md
CHANGED
|
@@ -23,7 +23,7 @@ To learn more about Storybook Docs, read the [general documentation](../README.m
|
|
|
23
23
|
First add the package. Make sure that the versions for your `@storybook/*` packages match:
|
|
24
24
|
|
|
25
25
|
```sh
|
|
26
|
-
yarn add -D @storybook/addon-docs
|
|
26
|
+
yarn add -D @storybook/addon-docs
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
Then add the following to your `.storybook/main.js` addons:
|