fix(a11y)!: use github-style header anchor generation #4609
Conversation
This file contains 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
BREAKING CHANGES: - `--vp-header-anchor-symbol` is removed - The default permalink function of markdown-it-anchor is changed to `linkAfterHeader`. This will need updates in your custom themes. This brings the original proposed behavior of #2039, #2040 which wasn't introduced to avoid breaking changes. fixes #2980 closes #2982
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
BREAKING CHANGES:
--vp-header-anchor-symbolis removed.linkAfterHeader. This will need updates in your custom themes.markdown.anchor.permalinkin your vitepress config to some other one frommarkdown-it-anchor.This brings the original proposed behavior of #2039, #2040 which wasn't introduced to avoid breaking changes.
fixes #2980
closes #2982
TODO: