Skip to content

Update custom heading IDs to include h5 and h6 support #4875

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ethanpalm merged 2 commits into from
Mar 25, 2026
Merged

Update custom heading IDs to include h5 and h6 support #4875

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00be79c
Update custom heading IDs to reflect h5 and h6 support
mintlify[bot] Mar 25, 2026
46f1f6a
remove note
ethanpalm Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions create/text.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,18 @@

### Custom heading IDs

By default, anchor IDs are generated automatically from header text. You can override the generated ID with a custom one using the `{#custom-id}` syntax:

Check warning on line 27 in create/text.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/text.mdx#L27 

In general, use active voice instead of passive voice ('are generated').

```mdx
## My section {#my-custom-anchor}
### Configuration options {#config}
##### Deep detail {#detail}
```

The custom ID replaces the auto-generated anchor, so you can link to the heading with `#my-custom-anchor` or `#config` instead of the default slugified text.

This is useful when you want stable anchor links that don't change if you update the heading text, or when you need shorter, more memorable anchors.

<Note>
Custom heading IDs are supported on heading levels 1 through 4 (`#` to `####`). Levels 5 and 6 are not supported.
</Note>

### Disabling anchor links

By default, headers include clickable anchor links that allow users to link directly to specific sections. You can disable these anchor links using the `noAnchor` prop in HTML or React headers.
Expand Down Expand Up @@ -81,8 +78,8 @@

```mdx
**_bold and italic_**
**~~bold and strikethrough~~**

Check warning on line 81 in create/text.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/text.mdx#L81 

Use 'Strikethrough' instead of 'strikethrough'.
*~~italic and strikethrough~~*

Check warning on line 82 in create/text.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/text.mdx#L82 

Use 'Strikethrough' instead of 'strikethrough'.
```

**_bold and italic_**<br />
Expand Down
Loading