Markdownlint: Markdownlint and TOP web app generate different heading IDs/fragments

[MaoShizhong]

Checks

• This is not a duplicate of an existing issue (please have a look through our open issues list to make sure)
• I have thoroughly read and understand The Odin Project Contributing Guide
• Would you like to work on this issue?

Describe your suggestion

Markdownlint's TOP051 rule (valid link fragments) uses GitHub's heading algorithm for generating link fragments from headings. This preserves dashes, so a heading like ### Title - Subtitle will generate title---subtitle.

TOP's web app's id/fragment generation removes these isolated dashes, so the above will become foo-bar. #title---subtitle will not scroll to the correct heading on our website but #title-subtitle will, except Markdownlint will flag #title-subtitle as an invalid link fragment as it expects #title---subtitle instead. This situation occurred recently in #28327.

A solution would be to replace dashes surrounded by spaces (so hyphenated words are preserved) with a colon and single space, since both serve to separate "parts" of a heading.

i.e. ### Title - subtitle should be fixable to ### Title: Subtitle.

Acceptance criteria

• New markdownlint rule flags any level headings if they contain SPACE DASH SPACE, and suggest the colon equivalent in the error message
• Fix info should convert the heading to the colon equivalent
• Dashes used to hyphenate words must be left alone
• Test .md file should demonstrate all reasonable positive and negative cases
• The rule should have an appropriate doc file
• Rule added to .markdownlint-cli2.jsonc config file custom rules array

Path

Other / NA

Lesson Url

N/A

(Optional) Discord Name

No response

(Optional) Additional Comments

No response