docs: update formatting for mdx3 compatibility #42052
Merged
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
dsanders11
approved these changes
May 6, 2024
ckerr
approved these changes
May 6, 2024
codebytere
approved these changes
May 7, 2024
|
Needs a manual backport for |
|
No Release Notes |
|
I have automatically backported this PR to "31-x-y", please check out #42070 |
1 task
erickzhao
added a commit
to erickzhao/ericktron
that referenced
this pull request
May 8, 2024
docs: update formatting for mdx3 compat
|
@erickzhao has manually backported this PR to "30-x-y", please check out #42099 |
VerteDinde
pushed a commit
that referenced
this pull request
May 9, 2024
* docs: update formatting for mdx3 compatibility (#42052) docs: update formatting for mdx3 compat * escape curly braces
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
Description of Change
Ran through the gamut of
npx docusaurus-mdx-checkerfor the Docusaurus v3 upgrade and this should clear the remaining issues:{and}both need to be escaped as MDX >=2 supports curly brace JS expressions (ref: https://mdxjs.com/docs/what-is-mdx/#expressions)<https://electronjs.org>(ref: https://docusaurus.io/blog/preparing-your-site-for-docusaurus-v3#bad-usage-of-gfm-autolink)<details><summary>Summary here</summary>doesn't work anymore in MDX >=2 for some reason and we need to add a line break now (ref: https://github.com/orgs/mdx-js/discussions/2241)cc @electron/docs
Checklist
npm testpassesRelease Notes
Notes: none