Skip to content

Document custom heading IDs syntax #4653

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document custom heading IDs syntax #4653

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions create/text.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@
Use descriptive, keyword-rich headers that clearly indicate the content that follows. This improves both user navigation and search engine optimization.
</Tip>

### Custom heading IDs

By default, anchor links are generated from the heading text. To set a custom anchor ID, add `{#your-id}` at the end of the heading:

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 heading {#custom-id}
```

This generates an anchor link of `#custom-id` instead of the default `#my-heading`. Custom IDs are useful when you want stable links that don't change if you rename a heading.

### 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 @@ -64,8 +74,8 @@

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

Check warning on line 77 in create/text.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/text.mdx#L77 

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

Check warning on line 78 in create/text.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/text.mdx#L78 

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

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