fix(storybook): Resolve MDX Block Loading Issues in Storybook #2396
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…-storybook-compatibility
🦋 Changeset detectedLatest commit: 76c6f95 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Closing, no changeset is needed since this original PR was merged and this isnt a feature that will be released but only an internal change. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This PR resolves runtime errors encountered when using MDX documentation in Storybook by pre-bundling the
@storybook/addon-docs/blocksmodule. The fix ensures compatibility with Vite's dependency optimization process during dynamic imports.Context:
The issue arises because Vite requires explicit pre-bundling of dynamically imported modules for compatibility during development. Without pre-bundling, Storybook fails to load MDX documentation correctly, leading to runtime errors. The solution modifies the
.storybook/main.tsconfiguration to include@storybook/addon-docs/blocksin theoptimizeDeps.includearray.Changes:
.storybook/main.tsto pre-bundle@storybook/addon-docs/blocks.References: