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

first-line-h1 insufficient replacement for first-heading-h1 #1416

Open
bbodenmiller opened this issue Nov 14, 2024 · 2 comments
Open

first-line-h1 insufficient replacement for first-heading-h1 #1416

bbodenmiller opened this issue Nov 14, 2024 · 2 comments

Comments

@bbodenmiller
Copy link

bbodenmiller commented Nov 14, 2024

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
Copy link
Owner

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
Copy link
Author

@DavidAnson starting_level option on MD001/heading-increment would certainly work!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants