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.

Sign up for GitHub

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

Jump to bottom

Remove deprecated MDX-GFM storybook addon #155

Open
maxatdetroit opened this issue Feb 9, 2024 · 0 comments
Open

Remove deprecated MDX-GFM storybook addon #155

maxatdetroit opened this issue Feb 9, 2024 · 0 comments
Labels
bug Something isn't working dependencies Update one or more dependencies version documentation Changes only affect the documentation internal Changes only affect the internal API patch Increment the patch version when merged prioritization-required This issue needs to be prioritized for future releases.

Comments

@maxatdetroit
Copy link
Member

Describe the bug

When running storybook, observe the warning about MDX addon deprecation:

WARN The "@storybook/addon-mdx-gfm" addon is meant as a migration assistant for Storybook 7.0; and will likely be removed in a future version.
WARN It's recommended you read this document:
WARN https://storybook.js.org/docs/react/writing-docs/mdx#lack-of-github-flavored-markdown-gfm
WARN
WARN Once you've made the necessary changes, you can remove the addon from your package.json and storybook config.

To Reproduce
Steps to reproduce the behavior:

  1. Go to project root
  2. Run yarn storybook
  3. See warning

Expected behavior

No deprecation warning should appear.

We need to follow the instruction at https://storybook.js.org/docs/writing-docs/mdx#lack-of-github-flavored-markdown-gfm to migrate any GFM styled markdown and remove the addon.
@maxatdetroit maxatdetroit added bug Something isn't working dependencies Update one or more dependencies version labels Feb 9, 2024
@maxatdetroit maxatdetroit changed the title Remove deprecated MDX storybook addon Remove deprecated MDX-GFM storybook addon Feb 9, 2024
@maxatdetroit maxatdetroit added prioritization-required This issue needs to be prioritized for future releases. patch Increment the patch version when merged internal Changes only affect the internal API documentation Changes only affect the documentation labels Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working dependencies Update one or more dependencies version documentation Changes only affect the documentation internal Changes only affect the internal API patch Increment the patch version when merged prioritization-required This issue needs to be prioritized for future releases.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@maxatdetroit