Skip to content

Commit

Permalink
docs(deps): Storybook migration doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Romainpetit committed Jul 17, 2024
1 parent aede8ee commit b43d02f
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Use Vue components inside MDX files, as if they were React components.

This addon is in its early stages, the following limitations apply:

- Only works with Vue 3 and Storybook 7
- Only works with Vue 3 and Storybook 8
- Components must be locally imported into MDX files
- Provide/Inject has not been tested yet but should work
- **Customisation APIs may change in the future**
Expand Down Expand Up @@ -68,3 +68,7 @@ You may also directly import and use Veaury's `applyVueInReact` as per Veaury's
Before reporting a bug, please thoroughly check Veaury's documentation and list of issues for matching issues.

To report a bug, please use GitHub issues on this repository, making sure to include a working Minimal Working Example. For instance, you could use [storybook.new](https://new-storybook.netlify.app/) to bootstrap a reproduction environment.

### Migrating to a later Storybook version

If you want to migrate the addon to support the latest version of Storyboook, you can check out the [addon migration guide](https://storybook.js.org/docs/addons/addon-migration-guide).
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
"format:fix": "prettier --write .",
"lint": "eslint --cache . --ext .ts,.tsx,.js,.jsx,.vue,.cjs",
"lint:fix": "yarn lint --fix",
"pack:local": "yarn pack -f storybook-addon-vue-mdx-$(date +%s).tgz",
"pack:local": "yarn pack --out storybook-addon-vue-mdx-$(date +%s).tgz",
"prebuild": "yarn clean",
"prepack:local": "yarn build",
"prepare": "husky install",
Expand Down Expand Up @@ -142,7 +142,7 @@
"peerDependencies": {
"@storybook/blocks": "^8.2.4",
"@storybook/builder-vite": "^8.2.4",
"@storybook/components": "^8.2.1",
"@storybook/components": "^8.2.4",
"@storybook/core-events": "^8.2.4",
"@storybook/manager-api": "^8.2.4",
"@storybook/mdx2-csf": "^1.1.0",
Expand Down
2 changes: 1 addition & 1 deletion yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -11330,7 +11330,7 @@ __metadata:
peerDependencies:
"@storybook/blocks": ^8.2.4
"@storybook/builder-vite": ^8.2.4
"@storybook/components": ^8.2.1
"@storybook/components": ^8.2.4
"@storybook/core-events": ^8.2.4
"@storybook/manager-api": ^8.2.4
"@storybook/mdx2-csf": ^1.1.0
Expand Down

0 comments on commit b43d02f

Please sign in to comment.