Skip to content
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

Enable markdownlint no-duplicate-header #27500

Merged
merged 1 commit into from
Oct 7, 2023

Conversation

silverwind
Copy link
Member

@silverwind silverwind commented Oct 7, 2023

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:

# 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: #27461 (comment)

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Oct 7, 2023
@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Oct 7, 2023
@github-actions github-actions bot added type/docs This PR mainly updates/creates documentation topic/code-linting labels Oct 7, 2023
@silverwind silverwind added the backport/v1.21 This PR should be backported to Gitea 1.21 label Oct 7, 2023
@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Oct 7, 2023
@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Oct 7, 2023
@silverwind silverwind merged commit 56ea9a4 into go-gitea:main Oct 7, 2023
25 checks passed
@GiteaBot GiteaBot added this to the 1.22.0 milestone Oct 7, 2023
@silverwind silverwind deleted the nodupeheader branch October 7, 2023 13:30
GiteaBot pushed a commit to GiteaBot/gitea that referenced this pull request Oct 7, 2023
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 GiteaBot added the backport/done All backports for this PR have been created label Oct 7, 2023
silverwind added a commit that referenced this pull request Oct 7, 2023
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:

```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: #27461 (comment)

Co-authored-by: silverwind <me@silverwind.io>
zjjhot added a commit to zjjhot/gitea that referenced this pull request Oct 8, 2023
* giteaoffical/main: (79 commits)
  Pre-register OAuth application for tea (go-gitea#27509)
  Fix mermaid flowchart margin issue (go-gitea#27503)
  add a shortcut to user's profile page to admin user details (go-gitea#27299)
  Fix actionlint (go-gitea#27513)
  [skip ci] Updated translations via Crowdin
  Update JS and PY dependencies (go-gitea#27501)
  Improve feed icons and feed merge text color (go-gitea#27498)
  Downgrade `go-co-op/gocron` to v1.31.1 (go-gitea#27511)
  Enable markdownlint `no-duplicate-header` (go-gitea#27500)
  bump go-deps (go-gitea#27489)
  Apply to became a maintainer (go-gitea#27491)
  change runner for binary
  [skip ci] Updated translations via Crowdin
  Remove .exe suffix when cross-compiling on Windows (go-gitea#27448)
  move re-useable workflow
  add checkout to disk-clean
  use hosted runners for nightly actions (go-gitea#27485)
  Avoid run change title process when the title is same (go-gitea#27467)
  Fix panic in storageHandler (go-gitea#27446)
  Rename the default themes to gitea-light, gitea-dark, gitea-auto (go-gitea#27419)
  ...
@go-gitea go-gitea locked as resolved and limited conversation to collaborators Jan 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backport/done All backports for this PR have been created backport/v1.21 This PR should be backported to Gitea 1.21 lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. topic/code-linting type/docs This PR mainly updates/creates documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants