Update from code changes: document code inside MDX fragments - #7209
Open
mintlify[bot] wants to merge 2 commits into
Open
Update from code changes: document code inside MDX fragments#7209mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
Summary
Code fences and inline code inside
<MDX>now compile exactly like code at the page root. Raw<,>,{, and}in fragment code no longer break the page, and character references like<decode to their characters per JSX text semantics. Previously there was no way to render a literal<inside fragment code at all.https://github.com/mintlify/mint/pull/10605
Changes
<MDX>component page with a placeholder-style code example.<.Note
Low Risk
Documentation-only updates with no runtime or build logic changes.
Overview
Documents new
<MDX>fragment code behavior: fences and inline code inside fragments compile like page-root code, and raw<,>,{, and}are allowed without escaping.Adds a Code in fragments section (with a conditional
git cloneplaceholder example) plus notes on character-reference decoding (<→<, literal<via&lt;). The same section is added in Spanish, French, and Chinese; ES/FR frontmatter descriptions are slightly shortened.Reviewed by Cursor Bugbot for commit 20a5a84. Bugbot is set up for automated code reviews on this repo. Configure here.