Update from code changes: document the MDX component - #7166
Open
mintlify[bot] wants to merge 2 commits into
Open
Update from code changes: document the MDX component#7166mintlify[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
Mintlify shipped a new
<MDX>component that renders its children as MDX, so authors can wrap a Markdown section in JSX and keep headings, code fences, and tables compiling like the rest of the page. Its main use is inside{...}expressions, where Markdown normally renders as plain text, enabling conditional Markdown sections driven by exported variables. Headings inside<MDX>are not yet merged into the page table of contents.Triggering change: https://github.com/mintlify/mint/pull/10530
Changes
components/mdx.mdxcovering pass-through behavior, a conditional-content example, block form, indentation handling, the table-of-contents caveat, and expansion limits (8 levels of nesting, 500 fragments per page).docs.json.es/,fr/,zh/) and added the matching navigation entries toes.json,fr.json, andzh.json.Note
Low Risk
Documentation and navigation-only changes with no runtime or application logic.
Overview
Adds documentation for Mintlify’s
<MDX>component so authors can render Markdown inside JSX expressions and keep headings, code fences, and tables compiling like normal page content.The new
components/mdx.mdxpage covers conditional Markdown (e.g. ternaries over exported variables), block form and indentation behavior, the caveat that headings inside<MDX>are excluded from the page TOC, and build limits (8 nesting levels, 500 expression fragments per page). The page is wired into the Components nav indocs.jsonandes.json/fr.json/zh.json, and an MDX card is added to the “Show and hide content” section on each locale’s components overview.Reviewed by Cursor Bugbot for commit 1524ca2. Bugbot is set up for automated code reviews on this repo. Configure here.