René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Document nuance around `no-duplicate-header` rule","articleBody":"This rule is set to `true` but I think there's some nuance around when this rule should be configured.\r\n\r\nThe rationale behind the [no-duplicate-header rule](https://github.com/DavidAnson/markdownlint/blob/v0.26.2/doc/Rules.md#md024---multiple-headings-with-the-same-content) is that some markdown parsers will generate anchor links from headings, and if the heading is the same, two headings in separate areas of the page will share the same anchor link. We see this issue in Primer docs. \r\n\r\nHowever, on GitHub repos, the GitHub markdown parser ensures headings that share same text have unique IDs so the generated anchor links are unique even if the heading text is the same. \r\n\r\nSo I believe we wouldn't need to enforce that heading texts on a page are completely non-duplicated in other cases. I don't believe it's necessary to have _completely_ unique heading text on a page for accessibility purposes. However, I believe there are accessibility benefits from enforcing that sibling headings are unique. \r\n\r\nWe could recommend setting `siblings_only` parameter which allows heading duplication for non-sibling headings and enforces sibling headings are unique.\r\n\r\nCould we document these nuances?","author":{"url":"https://github.com/khiga8","@type":"Person","name":"khiga8"},"datePublished":"2022-12-29T16:46:02.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":6},"url":"https://github.com/30/markdownlint-github/issues/30"}