mirror of
https://github.com/DavidAnson/markdownlint.git
synced 2026-04-25 09:16:02 +03:00
[GH-ISSUE #1416] first-line-h1 insufficient replacement for first-heading-h1 #681
Labels
No labels
bug
enhancement
enhancement
enhancement
fixed in next
fixed in next
fixed in next
new rule
new rule
new rule
pull-request
question
refactoring
refactoring
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
starred/markdownlint#681
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @bbodenmiller on GitHub (Nov 14, 2024).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/1416
There is times that the first line is not desired as a header (e.g. a TOC) but that we want to ensure the first header (which follows TOC) is in fact H1. This does not appear possible with
first-line-h1@DavidAnson commented on GitHub (Nov 14, 2024):
Agreed. I'm not sure the behavior you describe is entirely in keeping with the intent of MD041/first-line-heading, anyway.
However, it could be a reasonable thing for MD001/heading-increment to enforce, assuming it got a new parameter starting_level which would be set to 1 in your case.
https://github.com/DavidAnson/markdownlint/blob/main/doc/md001.md
@bbodenmiller commented on GitHub (Nov 14, 2024):
@DavidAnson starting_level option on MD001/heading-increment would certainly work!