- Notifications
You must be signed in to change notification settings - Fork5
Enforce asterisk-style unordered lists#41
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
👋 Hello and thanks for pinging us! An accessibility first responder will review this soon.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Repeatingmy comment from Slack:
I’m the likely candidate for the person who put that rule in the accessibility set, and if memory serves it was with the asterisk rule in mind. If it’s up to me we can merge this.
Approving.
Uh oh!
There was an error while loading.Please reload this page.
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.