docs: remove problematic mdx2 anchor id docs for MDX 2 migration#8788
Merged
Conversation
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site settings. |
⚡️ Lighthouse report for the deploy preview of this PR
|
|
Size Change: 0 B Total Size: 952 kB ℹ️ View Unchanged
|
7 tasks
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
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.
For MDX 2 (#8288) we have to apply a pre-processing step to escape heading ids so that it is valid MDX 2:
This usually works fine but when this is found inside a Markdown code block then it should probably be escaped.
It's possible to hack around this pre-processing by using JSX (or to fix the pre-processing but it would become less efficient).
Instead I choose to simply remove this special anchor id doc from the example here, considering it's already documented here: https://docusaurus.io/docs/markdown-features/toc#heading-ids
We can reintroduce this later if needed but for now it's simpler to remove it.
Removed in main so that my visual diff tool does not report a false positive.
CF https://app.argos-ci.com/slorber/docusaurus-visual-tests/builds/21/41550827