-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Custom header links #679
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.
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
Comments
A quick question, only for the customization of links generation, not including headers, right? |
Yes , but it would also be good to customize the Header link text:
|
OK, but recently I'm working for next major version (leverage |
Something like this would be really useful for us for a slightly different use-case. If we could mark headers with a unique code or reference then we could refer to that block of content even if it is moved between pages. Currently as we are developing our docs the structure is changing frequently and so we can't trust that links won't be broken. It would be great to be able to refer to a section in a canonical way that allows us to link to it more safely externally. For example, an href referring to some part of our help documentation might currently be: ## Creating Your First User <!-- ref: create-user --> Or similar. Then we could potentially have inbound links like: |
Solved! Plugin markdown-it-custom-header-link was created |
Thanks! I'll check, @abernov! |
Closing this as it's resolved by markdown-it-custom-header-link. |
Feature request
What problem does this feature solve?
In Vue Test Utils, we have headers generated from method names. Some of these include arguments, which leads to ugly headers and URLS:
## is(selector)
sidebar: is(selector)
path: /api/wrapper/#is-selector
What does the proposed API look like?
Add a way to control the generated header link:
How should this be implemented in your opinion?
As a markdown comment.
Are you willing to work on this yourself?**
Not at the moment, no
The text was updated successfully, but these errors were encountered: