Enable markdownlint no-duplicate-header (#27500)
#27506
Merged
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
Duplicate headers in a single Markdown document are problemlematic because the auto-generated links won't be stable. Enable this rule with no exceptions which is also the default of `markdownlint`. For example: ```md # A ## Example # B ## Example ``` Docasaurus will generated `example` and `example-1` links for this. If the first heading is altered, the link `example` will unexpectedly move to the second example heading. Ref: go-gitea#27461 (comment)
GiteaBot
added
type/docs
pull-request-size
bot
added
the
size/S
silverwind
approved these changes
Oct 7, 2023
GiteaBot
added
lgtm/need 1
lng2020
approved these changes
Oct 7, 2023
GiteaBot
added
lgtm/done
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Backport #27500 by @silverwind
Duplicate headers in a single Markdown document are problemlematic because the auto-generated links won't be stable. Enable this rule with no exceptions which is also the default of
markdownlint. For example:Docasaurus will generated
exampleandexample-1links for this. If the first heading is altered, the linkexamplewill unexpectedly move to the second example heading.Ref: #27461 (comment)