Skip to content
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

Markdown should be used only as intended #23

Open
1 task
Jenneh opened this issue Sep 14, 2022 · 2 comments
Open
1 task

Markdown should be used only as intended #23

Jenneh opened this issue Sep 14, 2022 · 2 comments
Labels
Style / Writers Guide Template Update test 1: navigation Related to the first round of user testing with navigation emphasized

Comments

@Jenneh
Copy link
Contributor

Jenneh commented Sep 14, 2022

Problem and context

In some cases, markdown is used for visual differentiation. This is confusing when using screen readers because markdown reads to mean a specific thing. Markdown should be used only as intended. ie. code blocks can’t be used for emphasis, just code. (ie. semantic HTML

Possible solutions

Make a rule in the Style guide about this.

Acceptance criteria

Tasks to complete

  • Create a style rule: Don’t use code block styling in markdown cells just for styling
@Jenneh Jenneh added test 1: navigation Related to the first round of user testing with navigation emphasized Template Update labels Sep 14, 2022
@tonyfast
Copy link
Contributor

is there a best practices document we could get started to capture this knowledge?
there some a good articles out there about using markdown correctly and i think could borrow from them.

@Jenneh do you have an example of code being used improperly the way it was described?

@tonyfast
Copy link
Contributor

something we could try is including AXE directly in the application to warn folks of accessibility violations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Style / Writers Guide Template Update test 1: navigation Related to the first round of user testing with navigation emphasized
Projects
None yet
Development

No branches or pull requests

3 participants