Markdownlint: note-box-headings custom rule
#28372
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add to markdownlint config custom rules array
MaoShizhong
added
the
Content: Markdownlint
Original propose TOP011 closed
Now made generic for multiple aspects of note box headings
3 different types of note box heading errors now - missing heading - incorrect heading level - incorrect heading start text (type-dependent) Will help make note boxes more accessible (linkable via heading id fragment, and note box type not limited to visual differences and div class).
MaoShizhong
changed the title
note-box-heading-level custom rulenote-box-headings custom rule
|
Rule converted from heading level to a general note box heading rule. Only the heading level error is practical to fix via a script. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
As discussed with staff, for better accessibility, note boxes should have headings which will make them click-linkable. These headings should have a consistent heading level enforced. Accessibility can also be improved by including the note box type as part of the heading (e.g. warning boxes with a heading like "Warning: Insert common pitfall here"), as we're currently only differentiating between types via border colour and small icons.
This PR
Issue
N/A
Additional Information
Pull Request Requirements
location of change: brief description of changeformat, e.g.Intro to HTML and CSS lesson: Fix link textBecausesection summarizes the reason for this PRThis PRsection has a bullet point list describing the changes in this PRIssuesection