Skip to content

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 26, 2023
Merged

Conversation

iansan5653
Copy link
Member

@iansan5653 iansan5653 commented Apr 25, 2023

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:

Fruits:

* Apple
* Banana
* Pear

VoiceOver on my machine reads:

Fruits {pause} star apple star banana star pear

Whereas with the following Markdown:

Fruits:

- Apple
- Banana
- Pear

VoiceOver reads:

Fruits {pause} apple {pause} banana {pause} pear

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 the style parameter set to consistent. This ensures that the list style is consistent across the whole file, based on the first encountered list item. What we really want is asterisk, which ensures that the list delimiter is always the * character.

@iansan5653 iansan5653 requested a review from a team as a code owner April 25, 2023 19:55
@accessibility-bot
Copy link
Collaborator

👋 Hello and thanks for pinging us! An accessibility first responder will review this soon.

  • 💻 On PRs for our review: please provide a review environment with steps to validate, screenshots (with alt text), or videos (with description following) demonstrating functionality we should be checking. This will help speed up our review and feedback cycle.
  • ⚠️ If this is urgent, please visit us in #accessibility on Slack and tag the first responder(s) listed in the channel topic.

Copy link
Collaborator

@andrialexandrou andrialexandrou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Repeating my 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.

@iansan5653 iansan5653 merged commit c71b2d6 into main Apr 26, 2023
@iansan5653 iansan5653 deleted the asterisk-list-style branch April 26, 2023 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants