Add code example for title property on code blocks#5329
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Add code example for title property on code blocks#5329mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
The editor now supports parsing and serializing the
title="..."syntax for code block titles, which was already supported on the rendered docs site. The existing documentation mentioned this syntax in text but only showed the inline format in code examples.title="..."property syntax alongside the existing inline syntaxtitleproperty) with a brief explanation of when each is usefulWhat shipped
Code block title handling was improved so the web editor properly round-trips the
title="..."meta syntax. This means users editing docs in the browser editor can now use eithertitle="..."or inline titles and have them preserved correctly.Note
Low Risk
Low risk: documentation-only changes that add examples/clarification with no runtime behavior impact.
Overview
Updates the code-block Title documentation to clearly describe the two supported title syntaxes (inline vs
title="...").Adds a new rendered example and matching MDX snippet demonstrating the
titlemeta property (including a file-path style title), alongside the existing inline-title example.Reviewed by Cursor Bugbot for commit 41db4fd. Bugbot is set up for automated code reviews on this repo. Configure here.