Skip to content

Document custom heading IDs#4690

Open
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/custom-heading-ids-1773880614
Open

Document custom heading IDs#4690
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/custom-heading-ids-1773880614

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Mar 19, 2026

Summary

  • Added documentation for the new {#custom-id} syntax that lets users set custom anchor IDs on headings (levels 1-4)
  • Updated the linking guide to reference custom anchor links alongside auto-generated ones

Headings now support a {#custom-id} suffix to override the auto-generated anchor link. This helps users keep anchors stable when renaming headings, create shorter anchor links, and avoid collisions.

Triggered by mintlify/mint@b5cf3f50.


Note

Low Risk
Documentation-only change that adds guidance for a new heading syntax; no runtime code or behavior is modified.

Overview
Documents the {#custom-id} suffix for headings so authors can override auto-generated anchor IDs, including guidance on supported heading levels, slug sanitization, and how duplicate IDs are disambiguated.

Updates the linking guide to include a Custom anchor links section and cross-links to the new Format text documentation.

Written by Cursor Bugbot for commit c0218d2. This will update automatically on new commits. Configure here.

Generated-By: mintlify-agent
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