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

Dependency Updates and MDX2 support #876

Merged
merged 2 commits into from
Nov 11, 2022

Conversation

nataliepina
Copy link
Collaborator

@nataliepina nataliepina commented Nov 10, 2022

Description

After Storybook was updated, a few issues came up with our mdx file rendering which is used for the Welcome, Colors, and Typography pages.
The issues are common and outlined here - storybookjs/storybook#18094
I followed the thread and the suggested workarounds have fixed the issues. In Storybook 7 (coming soon), mdx2 will be fully supported and suggested so we may be able to update some of these configurations at that point.
Additionally, I've had to remove the fragments wrapping the components in the mdx files which were previously required to render multiple components.

Which issue(s) does this PR relate to?

Testing

  1. npm install
  2. Start storybook and check the pages
  3. Tests pass ✅

Trade-offs

Screenshots

Checklist

  • If any new components were added, there are exported from packages/index.ts
  • This PR is associated with a JIRA and mentions in the commit message footer ("Closes …")
  • This PR contains breaking changes and states in the commit message body ("BREAKING CHANGE: …")
  • I have reviewed the changes and provided detail to the sections above

@nataliepina nataliepina requested a review from a team as a code owner November 10, 2022 17:06
@nataliepina nataliepina force-pushed the npina/chore/nov-deps-maintenance branch from bb8baf5 to 847b4c0 Compare November 10, 2022 17:15
],
features: {
previewMdx2: true
}
Copy link
Collaborator Author

@nataliepina nataliepina Nov 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Required to support mdx2, mdx files will render as blank pages otherwise.

Copy link
Contributor

@mstruebing mstruebing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🥇

@nataliepina nataliepina merged commit 393bcec into main Nov 11, 2022
@nataliepina nataliepina deleted the npina/chore/nov-deps-maintenance branch November 11, 2022 15:13
@github-actions
Copy link

🎉 This PR is included in version 11.4.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

2 participants