Update from code changes: inline Markdown in component titles - #7176
Closed
mintlify[bot] wants to merge 2 commits into
Closed
Update from code changes: inline Markdown in component titles#7176mintlify[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
1 participant
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
Documents new support for inline Markdown formatting in the
titleprop of the Accordion, Card, Step, Tab, Tile, and Color.Row components.The triggering change compiles bounded inline Markdown in component titles at build time. Authors can now use bold, italic, strikethrough, inline code, and links in title strings. Links render as styled label text rather than clickable links, and block Markdown, images, HTML, and MDX components stay literal. Anchor IDs, table of contents entries, and tab synchronization use the plain text of the title. See https://github.com/mintlify/mint/pull/10483
Changes
titleproperty on the Accordions, Cards, Steps, Tabs, Tiles, and Color component pagesNote
Low Risk
Documentation and navigation only; no runtime or application code changes.
Overview
This PR documents inline Markdown in the
titleprop for Accordion, Card, Step, Tab, Tile, and Color.Row, matching the platform change in mint#10483.It adds a new Help center article (
format-component-titles-with-markdown) covering supported syntax (bold, italic, strikethrough, inline code, links), limitations (links are styled only; block MDX/HTML stays literal), and behavior for anchor IDs, TOC, and tab sync (plain text after stripping markup). Each affected component reference page now notes Markdown support ontitleand links to that article.The same content and nav entry are added for Spanish, French, and Chinese (
docs.json,es.json,fr.json,zh.json).Reviewed by Cursor Bugbot for commit c7940d2. Bugbot is set up for automated code reviews on this repo. Configure here.