[doc] Disable auto-included addon-docs when adding GFM plugin
#31078
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This fixes a confusing issue when you try to add the GFM plugin, when using `addon-essentials` (AFAIK, that's the default?): Storybook ignores the new plugin because the `docs` add-on was already included. Changing code order doesn't seem to help, either. I only found the solution after digging through this old issue: storybookjs#20091 (comment) > **Note:** this should also be fixed for [v7](https://storybook.js.org/docs/7/writing-docs/mdx#anatomy-of-mdx), but I didn't find the correct branch to edit that - the "edit on GitHub" link simply takes me to `next`, where the v7 files don't exist anymore.
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
LGTM
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
There was a problem hiding this comment.
LGTM
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
|
Thank you very much for your contribution. In Storybook 9, we eliminate |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to #24718 (could close it if I get some help haha), related to 24743
What I did
This fixes a confusing issue when you try to add the GFM plugin, when using
addon-essentials(AFAIK, that's the default?): Storybook ignores the new plugin because thedocsadd-on was already included. Changing code order doesn't seem to help, either.I only found the solution after digging through this old issue: #20091 (comment)
What's missing
This should also be fixed for v7, but I didn't find the correct branch to edit that - the "edit on GitHub" link simply takes me to
next, where the v7 files don't exist anymore.If someone can point me in the correct direct to fix that, I can also add a note about the requirement of
remark-gfm@v3, as pointed at #24743 (comment) - this is also an issue I faced on v7. Then, I guess we could auto-close #24718.Checklist for Contributors
Testing
This is just a documentation change, so no testing?
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>Greptile Summary
Updated the documentation snippet to clarify GFM plugin configuration with Storybook when using auto-included addon-docs from addon-essentials.
docs/_snippets/storybook-main-config-remark-options.mdto include clear JavaScript and TypeScript examples.💡 (1/5) You can manually trigger the bot by mentioning @greptileai in a comment!