[Proposal] Rule to disallow links in headings

[Arty-chan]

A lot of markdown renderers on sites auto-create anchor links to headings.

While if there is a link in a heading, the anchor will still work, clicking on the heading can lead you to the specified link instead of giving you the anchor link. This disrupts the default behaviour of the heading.

It's particularly problematic in something that is generated off the headings. For example, if you have a table of contents generated from the headings, many generators will not strip out the link, so when you click on the heading in the table of contents, it goes to the specified link instead of to the heading on the current page.

I'm creating a custom rule in another linter (vale) so it's not a priority for me, but thought this would be a good idea to include as a rule in markdownlint.

[berot3]

I think it would be nice to have the option to disallow links in headings. but i als agree with the discussion here #762

[Malix-Labs]

Duplicate of #762

[DavidAnson]

Agreed, I will close this per the discussion in #762.