Document custom heading IDs in MDX#4622
Closed
mintlify[bot] wants to merge 3 commits into
Closed
Conversation
Generated-By: mintlify-agent
… IDs Generated-By: mintlify-agent
Generated-By: mintlify-agent
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
create/text.mdxexplaining the{#custom-id}syntax for overriding auto-generated anchor links on headings (h1-h4)guides/linking.mdxto mention the custom ID override option in the "How anchor links are generated" section with a cross-referenceRelated: mintlify/mint#6586
Note
Low Risk
Low risk documentation-only change that adds guidance and examples for overriding auto-generated anchor slugs; no runtime behavior is modified.
Overview
Documents custom heading IDs for MDX headings via
{#custom-id}increate/text.mdx, including slugification behavior, supported heading levels (H1–H4), and collision handling.Updates
guides/linking.mdxto mention the custom-ID override in the anchor-generation section, with an example and cross-link back to the new docs section.Written by Cursor Bugbot for commit 2ba2c4c. This will update automatically on new commits. Configure here.