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

Storybook: Migrate stories contents regarding GitHub flavored markdown #2046

Open
mfranzke opened this issue Nov 22, 2023 · 0 comments
Open
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@mfranzke
Copy link
Member

mfranzke commented Nov 22, 2023

As a follow up to #2093 we'd have to migrate some documentations contents:

In MDX1 you had the option of using GitHub flavored markdown.
Storybook 7.0 uses MDX2 for compiling MDX, and thus no longer supports GFM out of the box.
Because of this you need to explicitly add the GFM plugin in the addon-docs options:
https://storybook.js.org/docs/react/writing-docs/mdx#lack-of-github-flavored-markdown-gfm
We recommend you follow the guide on the link above, however we can add a temporary storybook addon that helps make this migration easier.
We'll install the addon and add it to your storybook config.

@mfranzke mfranzke added the documentation Improvements or additions to documentation label Nov 22, 2023
@mfranzke mfranzke added this to the Release 1.0 milestone Nov 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant