Enforce asterisk-style unordered lists #41
Merged
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.
Asterisk style lists (ie,
* item
) are preferred over other list styles because asterisks are most likely to be read out by screen readers. For example, given the following Markdown:VoiceOver on my machine reads:
Whereas with the following Markdown:
VoiceOver reads:
This makes it much less obvious that what is being read is actually a list.
The current configuration enables the
ul-style
rule, but by default this rule has thestyle
parameter set toconsistent
. This ensures that the list style is consistent across the whole file, based on the first encountered list item. What we really want isasterisk
, which ensures that the list delimiter is always the*
character.