Skip to content

Update from code changes: document the MDX component - #7166

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/d3ce5311
Open

Update from code changes: document the MDX component#7166
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/d3ce5311

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

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

  • Added components/mdx.mdx covering 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).
  • Added the page to the Components group in docs.json.
  • Added an MDX card to the "Show and hide content" section of the components overview.
  • Mirrored the new page and overview card into Spanish, French, and Chinese (es/, fr/, zh/) and added the matching navigation entries to es.json, fr.json, and zh.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.mdx page 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 in docs.json and es.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.

@mintlify

mintlify Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Aug 28, 2026, 2:09 AM

@mintlify

mintlify Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟡 Building Aug 28, 2026, 2:08 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants