Markdownlint: dashes-in-headings
custom rule
#28330
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Because
Markdownlint and VSC use GitHub's heading algorithm to generate fragments, which gives different results to Ruby on Rails'
#parameterize
method when dealing with isolated dashes (a dash group surrounded by spaces, used as a separator).This leads to the TOP-valid fragment for
### Heading - Subheading
triggering the MD051 rule, and the Markdownlint-valid fragment not matching the correct heading ID.While we can use
### Heading - Subheading {#heading-subheading}
for Markdownlint and VSC to pick up, this looks messy and just gives us an extra point of failure if we change the heading but forget to change the custom ID.The solution is to enforce colons as separators, leaving other dash uses (like hyphens or CLI flags) in headings alone. Markdownlint and our web app will both convert
### Heading: Subheading and hyphenated-word
toheading-subheading-and-hyphenated-word
.This PR
Issue
Closes #28328
Additional Information
N/A
Pull Request Requirements
location of change: brief description of change
format, e.g.Intro to HTML and CSS lesson: Fix link text
Because
section summarizes the reason for this PRThis PR
section has a bullet point list describing the changes in this PRIssue
section