docs: suggest using {<...>...</...>} if don't use Markdown in migra…#10167
Merged
slorber merged 1 commit intofacebook:mainfrom May 27, 2024
Merged
docs: suggest using {<...>...</...>} if don't use Markdown in migra…#10167slorber merged 1 commit intofacebook:mainfrom
{<...>...</...>} if don't use Markdown in migra…#10167slorber merged 1 commit intofacebook:mainfrom
Conversation
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
This was referenced Jun 22, 2024
This was referenced Jun 22, 2024
This was referenced Jun 27, 2024
This was referenced Sep 6, 2024
This was referenced Sep 13, 2024
This was referenced Sep 28, 2024
This was referenced Oct 4, 2024
This was referenced Oct 19, 2024
Open
Open
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.
Pre-flight checklist
Motivation
If you want to migrate complex JSX expressions in MDXv1 + Docusaurus v1/2 to MDXv3 + Docusaurus v3, you can just wrap them with
{...}.You can't use Markdown syntax there (as before), but don't have to care about the extra insertion of
<p>elements.This will help you if you have to migrate documents that have complex JSX expressions that you don't want to touch.
MDX v1
↓
MDX v2 & 3
Test Plan
https://deploy-preview-10167--docusaurus-2.netlify.app/docs/migration/v3#unintended-extra-paragraphs
https://deploy-preview-10167--docusaurus-2.netlify.app/docs/3.3.2/migration/v3/#unintended-extra-paragraphs
Test links
Deploy preview: https://deploy-preview-10167--docusaurus-2.netlify.app/
Related issues/PRs