docs: v2 docs should discourage the usage of a lower-case MDX component (will not work in v3)#8779
Merged
Merged
Conversation
slorber
added
the
pr: documentation
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site settings. |
⚡️ Lighthouse report for the deploy preview of this PR
|
slorber
changed the title
|
Size Change: 0 B Total Size: 952 kB ℹ️ View Unchanged
|
This was referenced Oct 19, 2023
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Motivation
In MDX v2, lower-case elements can't be replaced by custom components anymore. Only the upper-case components can.
The following will stop working in Docusaurus v3, so we should start encouraging users to not use lower-case tag names for custom MDX components, even if it still temporarily works
Also did some cleanup that was related to prepare for MDX 2 (for example there's no more
MDXComponents/Headcomponent)Test Plan
preview
Test links
https://deploy-preview-8779--docusaurus-2.netlify.app/docs/markdown-features/react#mdx-component-scope
Related issues/PRs
MDX 2 PR: #8288