Repository navigation
docs: explain how custom React components appear in Markdown export - #7946
Merged
brandonmcconnell merged 3 commits intoOct 21, 2026
Merged
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
…fr, zh Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
brandonmcconnell
deleted the
brandon/markdown-export-custom-components
branch
October 21, 2026 19:30
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.
Documentation changes
Documents how custom React components and imported snippet data appear in Markdown exports. The "Components and HTML" section already covers built-in components, HTML, and snippets, but not JSX components or data. Customers like Perplexity had to reverse-engineer that behavior from other sites' output.
ai/markdown-export: new "Custom React components" subsection under "Components and HTML".title,description,alt, andhrefprops, or are omitted if they have none.components/visibility: new "Interactive components" section.for="humans"widget with afor="agents"rate table.Visibilityisn't needed to keep code out of Markdown.Translations: the same sections are added to the
es,fr, andzhpages, using the existing<div id>wrappers so the English anchors work in every language.Agent skill (
agent-context): updates theVisibilityentry inreference/components.md, which told agents to wrap custom components infor="humans"to keep code out of Markdown. Also adds a Markdown output bullet toreference/customization/react-and-snippets.md.skill.mdis generated only fromSKILL.md, so it doesn't change, andnpm run checkandnpm testpass.Reflects the markdown flattening behavior shipped in mintlify/mint#12927 and the stacked PRs above it.
For Reviewers
When reviewing documentation PRs, please consider:
✅ Technical accuracy
✅ Clarity and completeness
✅ User experience
Note
Low Risk
Documentation-only updates with no runtime, auth, or data-handling changes.
Overview
Documents how custom React components and imported snippet data show up in Markdown export (
.mdURLs andllms-full.txt), matching the flattening behavior from the product change.ai/markdown-exportgains a Custom React components subsection: exports never include component source or imported props/data; static components become Markdown; interactive ones only keep children plustitle,description,alt, andhref(otherwise omitted).components/visibilityadds Interactive components with a pricing-calculator vs. agent table example and clarifies thatVisibilityis for audience-specific content, not for stripping code from Markdown.The same sections land in es, fr, and zh with stable
#custom-react-components/#interactive-componentsanchors. Agent skill references update the old guidance that suggested wrapping custom components infor="humans"only to hide source from Markdown.Reviewed by Cursor Bugbot for commit ca727cd. Bugbot is set up for automated code reviews on this repo. Configure here.