Multiple top level headings don't follow markdown linting guidelines

Issue #13 new
Emilio Martinez-Cordero created an issue

This project relies on Markdown, which makes it really easy to use, especially because it established a very short and simple set of rules to make it work with PRs in Bitbucket. However, one of those rules happens to contradict a fairly common guideline followed across multiple document standards: avoiding the use of multiple top level headers.

In the case of Markdown, for example, it is usually enforced by linting: "MD025 - Multiple top level headers in the same document". In the case of HTML, for example, it's noted within the Web Content Accessibility Guidelines:

That said, of course, it contradicts guidelines such as .


Do not use the top level headers as categories but instead have that be the level 2 headers. The third level headers can be used for the rules respectively.

Comments (1)

  1. Log in to comment