@storybook/addon-docs 8.4.0-alpha.7 → 8.4.0-beta.0
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/package.json +5 -5
package/README.md
CHANGED
|
@@ -76,7 +76,7 @@ For more information on `MDX`, see the [`MDX` reference](https://github.com/stor
|
|
|
76
76
|
|
|
77
77
|
Storybook Docs supports all view layers that Storybook supports except for React Native (currently). There are some framework-specific features as well, such as props tables and inline story rendering. The following page captures the current state of support:
|
|
78
78
|
|
|
79
|
-
[Framework Support](https://storybook.js.org/docs/
|
|
79
|
+
[Framework Support](https://storybook.js.org/docs/configure/integration/frameworks-feature-support)
|
|
80
80
|
|
|
81
81
|
**Note:** `#` = WIP support
|
|
82
82
|
|
|
@@ -139,11 +139,11 @@ export default {
|
|
|
139
139
|
|
|
140
140
|
`csfPluginOptions` is an object for configuring `@storybook/csf-plugin`. When set to `null` it tells docs not to run the `csf-plugin` at all, which can be used as an optimization, or if you're already using `csf-plugin` in your `main.js`.
|
|
141
141
|
|
|
142
|
-
> With the release of version 7.0, it is no longer possible to import `.md` files directly into Storybook using the `transcludeMarkdown` [option](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#importing-plain-markdown-files-with-transcludemarkdown-has-changed). Instead, we recommend using the [`Markdown`](https://storybook.js.org/docs/
|
|
142
|
+
> With the release of version 7.0, it is no longer possible to import `.md` files directly into Storybook using the `transcludeMarkdown` [option](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#importing-plain-markdown-files-with-transcludemarkdown-has-changed). Instead, we recommend using the [`Markdown`](https://storybook.js.org/docs/api/doc-blocks/doc-block-markdown) Doc Block for importing Markdown files into your Storybook documentation.
|
|
143
143
|
|
|
144
144
|
## TypeScript configuration
|
|
145
145
|
|
|
146
|
-
As of SB6 [TypeScript is zero-config](https://storybook.js.org/docs/
|
|
146
|
+
As of SB6 [TypeScript is zero-config](https://storybook.js.org/docs/configure/integration/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).
|
|
147
147
|
|
|
148
148
|
## More resources
|
|
149
149
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@storybook/addon-docs",
|
|
3
|
-
"version": "8.4.0-
|
|
3
|
+
"version": "8.4.0-beta.0",
|
|
4
4
|
"description": "Document component usage and properties in Markdown",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"addon",
|
|
@@ -98,9 +98,9 @@
|
|
|
98
98
|
},
|
|
99
99
|
"dependencies": {
|
|
100
100
|
"@mdx-js/react": "^3.0.0",
|
|
101
|
-
"@storybook/blocks": "8.4.0-
|
|
102
|
-
"@storybook/csf-plugin": "8.4.0-
|
|
103
|
-
"@storybook/react-dom-shim": "8.4.0-
|
|
101
|
+
"@storybook/blocks": "8.4.0-beta.0",
|
|
102
|
+
"@storybook/csf-plugin": "8.4.0-beta.0",
|
|
103
|
+
"@storybook/react-dom-shim": "8.4.0-beta.0",
|
|
104
104
|
"react": "^16.8.0 || ^17.0.0 || ^18.0.0",
|
|
105
105
|
"react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0",
|
|
106
106
|
"ts-dedent": "^2.0.0"
|
|
@@ -117,7 +117,7 @@
|
|
|
117
117
|
"vite": "^4.0.4"
|
|
118
118
|
},
|
|
119
119
|
"peerDependencies": {
|
|
120
|
-
"storybook": "^8.4.0-
|
|
120
|
+
"storybook": "^8.4.0-beta.0"
|
|
121
121
|
},
|
|
122
122
|
"publishConfig": {
|
|
123
123
|
"access": "public"
|