From b43d02fdf3183e4cca5a890a713a2ee12963049a Mon Sep 17 00:00:00 2001 From: Romain Petit Date: Wed, 17 Jul 2024 09:06:04 +0200 Subject: [PATCH] docs(deps): Storybook migration doc --- README.md | 6 +++++- package.json | 4 ++-- yarn.lock | 2 +- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c989903..c6c4b7f 100644 --- a/README.md +++ b/README.md @@ -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** @@ -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). diff --git a/package.json b/package.json index c06d083..0dd281c 100644 --- a/package.json +++ b/package.json @@ -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", @@ -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", diff --git a/yarn.lock b/yarn.lock index 43fb962..f76eabb 100644 --- a/yarn.lock +++ b/yarn.lock @@ -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