docs: note custom heading IDs preserve casing#5942
Closed
mintlify-development[bot] wants to merge 1 commit into
Closed
docs: note custom heading IDs preserve casing#5942mintlify-development[bot] wants to merge 1 commit into
mintlify-development[bot] wants to merge 1 commit into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
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
2 participants
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
Document that custom heading IDs written with
{#id}syntax now preserve casing and separators (camelCase, snake_case, kebab-case) instead of being lowercased and hyphenated.Changes
create/text.mdx: Added casing preservation note and examples to the Custom heading IDs section.guides/linking.mdx: Added casing note to the Custom anchor IDs section.es/,fr/, andzh/translations.Context
Upstream fix in
mintlify/mintreplaces slug-style normalization of custom heading IDs with a sanitizer that preserves casing. Auto-generated heading IDs (headings without{#id}) are unchanged. This unblocks migrations from documentation platforms that rely on camelCase anchors.Note
Low Risk
Low risk docs-only updates; changes are limited to wording/examples across translated pages and do not affect runtime behavior.
Overview
Documents that custom heading/anchor IDs provided via
{#id}preserve casing and separators as written (e.g.,camelCase,snake_case,kebab-case), including new examples and migration rationale.Updates the same guidance in
create/text.mdxandguides/linking.mdx, and mirrors the clarification in thees/,fr/, andzhtranslations; auto-generated heading IDs are explicitly noted as unchanged.Reviewed by Cursor Bugbot for commit f946eea. Bugbot is set up for automated code reviews on this repo. Configure here.