Skip to content

Add code example for title property on code blocks#5329

Open
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/code-block-title-example-1776116078
Open

Add code example for title property on code blocks#5329
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/code-block-title-example-1776116078

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify bot commented Apr 13, 2026

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.

  • Added a code example demonstrating the title="..." property syntax alongside the existing inline syntax
  • Clarified the two ways to set titles (inline vs title property) with a brief explanation of when each is useful

What 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 either title="..." 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 title meta 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.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify bot commented Apr 13, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 13, 2026, 9:38 PM

@mintlify-development
Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
userauth 🟡 Building Apr 13, 2026, 9:35 PM

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