Ability to set explicit "named" anchors for headings #2181
alexakreizinger
started this conversation in
Feature Requests
Replies: 1 comment 1 reply
-
|
The great thing about this is that if you often link to specific sections of your docs, for example from blogs, then even if you change the header name, the link from externally won't break. With the current behavior it will break because the anchor is generated from the text so if the text changes the anchor does too. |
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Request
Add the ability to explicitly define anchors for headings.
Current behavior
Anchors always match the name of the associated heading. For example,
## this is my headinggenerates the anchorexample.com/page#this-is-my-heading.Reason for request
There are times where I need to use two headings with the same name on the same page. Currently, Mintlify appends
-2,-3, etc. to anchors for headings with identical names, but being able to set custom anchor names is more predictable behavior and makes it easier to link between pages/headings without issue.Example implementation
In other markdown-based docs tools I've used, the syntax has been something like this:
...which generates the anchor
example.com/page#custom-anchor.Beta Was this translation helpful? Give feedback.
All reactions