-
-
Notifications
You must be signed in to change notification settings - Fork 8.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(v2): ability to "escape" JSX in MDX files as code blocks #4278
Merged
Conversation
This file contains 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
[V1] Deploy preview success Built with commit f7e2d34 |
Size Change: 0 B Total Size: 544 kB ℹ️ View Unchanged
|
Deploy preview for docusaurus-2 ready! Built with commit f7e2d34 |
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4278--docusaurus-2.netlify.app/classic/ |
This was referenced Mar 10, 2021
Closed
Closed
Closed
Closed
This was referenced Mar 13, 2021
Merged
Merged
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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
Crowdin just added support for the .mdx extension.
It is not real MDX support, but they now interpret .mdx files as md instead of plain text.
The problem is that external tools like Crowdin totally mess-up with the JSX when we download back the translations.
Simple JSX like
<UserName name="seb"/>
works (ie string props), but as soon as you start to useprop={{x,y,z}}
it messes-up.The idea:
Note wrapping in this escape code block is an escape hatch for the mdx + Crowdin (or maybe other saas?) integrations and should be avoided in most cases, as it:
@yangshun and Titus from MDX seemed to agree it is a viable workaround
Open for other names for the code block, currently choose:
mdx-code-block
Can validate that the current doc changes will work for Crowdin to not mess-up with our own site.
Will implement tomorrow the remark plugin