MD025 Multiple top-level headings in the same document
By extension, MD001 - Heading levels should only increment by one level at a time
The change to headers is debatable, so I have included it as a separate commit after all the other more basic lints.
While markdown dictates that there should only be a single h1 element, it is mostly helpful for semantic styling like with Obsidian themes. In this case, though, the readme will be read on GitHub where it is rendered with a set style. It could be argued that the header size of an h1 element looks better than if they were changed to be more semantically correct.
I leave the decision of whether to accept the header level commit to the repo's maintainer.
The readme had a few markdown errors (checked via the markdownlint plugin for Visual Studio Code) for spacing and header semantics.
This pull request addresses:
MD009
- Trailing spacesMD012
- Multiple consecutive blank linesMD022
- Headings should be surrounded by blank linesMD032
- Lists should be surrounded by blank linesMD025
Multiple top-level headings in the same documentMD001
- Heading levels should only increment by one level at a timeThe change to headers is debatable, so I have included it as a separate commit after all the other more basic lints.
While markdown dictates that there should only be a single
h1
element, it is mostly helpful for semantic styling like with Obsidian themes. In this case, though, the readme will be read on GitHub where it is rendered with a set style. It could be argued that the header size of anh1
element looks better than if they were changed to be more semantically correct.I leave the decision of whether to accept the header level commit to the repo's maintainer.