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

Docs: Remove the "@storybook/addon-mdx-gfm" addon #3031

Open
coliff opened this issue Nov 26, 2024 · 1 comment
Open

Docs: Remove the "@storybook/addon-mdx-gfm" addon #3031

coliff opened this issue Nov 26, 2024 · 1 comment
Labels
2 2 story points dependencies Pull requests that update a dependency file docs

Comments

@coliff
Copy link
Member

coliff commented Nov 26, 2024 •
edited
Loading

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

The above shows when building/serving Storybook. Looks safe to remove.
@coliff coliff added 1 1 story point dependencies Pull requests that update a dependency file docs labels Nov 26, 2024
@coliff coliff moved this from In Review to In Progress in Modus Web Components Nov 26, 2024
@coliff coliff self-assigned this Nov 26, 2024
@coliff coliff linked a pull request Nov 26, 2024 that will close this issue
Docs: Remove @storybook/addon-mdx-gfm #3032
Closed
13 tasks
@coliff coliff removed their assignment Nov 26, 2024
@coliff
Copy link
Member Author

coliff commented Nov 26, 2024

This isn't super straightforward as I had originally anticipated. Our tables aren't formatted so we need another plugin. Details here:
https://storybook.js.org/docs/writing-docs/mdx#markdown-tables-arent-rendering-correctly

@coliff coliff added 2 2 story points and removed 1 1 story point labels Nov 26, 2024
@coliff coliff removed the status in Modus Web Components Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
2 2 story points dependencies Pull requests that update a dependency file docs
Projects
Modus Web Components
Status: No status
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs: Remove @storybook/addon-mdx-gfm trimble-oss/modus-web-components
1 participant
@coliff