Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Addon-docs: MDX2 support #17514

Closed
shilman opened this issue Feb 16, 2022 · 6 comments
Closed

Addon-docs: MDX2 support #17514

shilman opened this issue Feb 16, 2022 · 6 comments

Comments

@shilman
Copy link
Member

shilman commented Feb 16, 2022

MDX has released version 2 with better parsing, improved speed, and security fixes.

We should provide opt-in support for MDXv2 in SB6.5 and completely move to MDXv2 in SB7.0.

@shilman
Copy link
Member Author

shilman commented Feb 21, 2022

closing as dupe to #17137 17137

@shilman shilman closed this as completed Feb 21, 2022
@shilman
Copy link
Member Author

shilman commented Feb 28, 2022

Olé!! I just released https://github.com/storybookjs/storybook/releases/tag/v6.5.0-alpha.43 containing PR #17515 that references this issue. Upgrade today to the @next NPM tag to try it out!

npx sb upgrade --prerelease

@shilman
Copy link
Member Author

shilman commented Feb 28, 2022

Hey gang! A lot of you have been waiting a long time for MDXv2. I've released experimental support in Storybook 6.5 and would love your help to kick the tires. I've written up a short guide here and will update it with the latest as it stabilizes:

https://gist.github.com/shilman/6ff2d7e18db8846e8fc552fb432ae4f6

@julrich
Copy link

julrich commented Apr 19, 2022

Hey gang! A lot of you have been waiting a long time for MDXv2. I've released experimental support in Storybook 6.5 and would love your help to kick the tires. I've written up a short guide here and will update it with the latest as it stabilizes:

https://gist.github.com/shilman/6ff2d7e18db8846e8fc552fb432ae4f6

This sounds great. Maybe the timing aligns, could really use that for documenting a major upcoming migration of our component library. Would love to use https://codehike.org/ for their great code sample components... but it's only MDXv2.
Will let you know if there's any feedback (not sure at what timeline you're looking at for feedback).

@shilman
Copy link
Member Author

shilman commented Apr 19, 2022

@julrich we're putting this out as experimental in 6.5 and it will become the default as a breaking change in SB7.0. If you run into any issues with it at any point, please let me know. At some point in the next few months I'd also love to demo you some MDX changes that we're making for 7.0 to see what you think.

@julrich
Copy link

julrich commented Apr 19, 2022

Cool, looking forward to this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants