Skip to content

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

Merged
ethanpalm merged 3 commits into
mainfrom
mintlify/d3ce5311
Aug 28, 2026
Merged

Update from code changes: document the MDX component#7166
ethanpalm merged 3 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; no runtime or application code changes.

Overview
Adds documentation for Mintlify’s new <MDX> component so authors can compile Markdown (headings, fences, tables) inside JSX—especially in {...} conditionals where Markdown would otherwise render as plain text.

New components/mdx.mdx covers conditional examples, block form (blank line after the opening tag), expression indentation stripping, the TOC caveat for headings inside <MDX>, and build limits (8 nesting levels, 500 fragments per page). The Components nav in docs.json and an overview card in components/index.mdx are updated; the same page and card are added for Spanish, French, and Chinese (es/, fr/, zh/ plus locale JSON nav entries).

Reviewed by Cursor Bugbot for commit 87788d5. 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.

Comment thread components/mdx.mdx Outdated
Comment thread es/components/mdx.mdx Outdated
Comment thread fr/components/mdx.mdx Outdated
Comment thread zh/components/mdx.mdx Outdated
Comment thread components/mdx.mdx Outdated
Comment thread components/mdx.mdx Outdated
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
@ethanpalm
ethanpalm merged commit cb8af8c into main Aug 28, 2026
5 checks passed
@ethanpalm
ethanpalm deleted the mintlify/d3ce5311 branch August 28, 2026 17:15
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.

1 participant