feat(cli): write-heading-ids CLI now supports the --syntax option#11777
Merged
feat(cli): write-heading-ids CLI now supports the --syntax option#11777
write-heading-ids CLI now supports the --syntax option#11777Conversation
slorber
changed the title
write-heading-ids CLI, introduce new --syntax mdx-comment optionwrite-heading-ids CLI now supports the --syntax mdx-comment option
slorber
changed the title
write-heading-ids CLI now supports the --syntax mdx-comment optionwrite-heading-ids CLI now supports the --syntax option
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
✅ [V2]
To edit notification comments on pull requests, go to your Netlify project configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
|
Size Change: +807 B (+0.01%) Total Size: 11.9 MB
ℹ️ View Unchanged
|
|
Size Change: +841 B (+0.01%) Total Size: 12.3 MB
ℹ️ View Unchanged
|
2 tasks
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
1 participant
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
Follow up on #11755
The MDX parser doesn't natively support our "classic"
{#headingId}syntax anymore (since MDX v2+)We added support for a new natively supported syntax in #11755 based on comments (
{/* #headingId */})This PR completes the support for the
docusaurus write-heading-idsCLI by introducing a new--syntax mdx-commentCLI option to opt-in for this newly supported syntax.By default, the CLI keeps using the
--syntax classicbased on{#headingId}. We'll figure out progressively our to roll this feature out.It's unclear if we'll ever deprecate the classic syntax, considering it remains useful for CommonMark usage and is also supported by other tools relying on CommonMark. The main problem is the MDX incompatibility.
Test Plan
CI + dogfood
Test links
https://deploy-preview-11777--docusaurus-2.netlify.app/