Iota-School / notebooks-for-all

https://iota-school.github.io/notebooks-for-all/
Other
18 stars 6 forks source link

Markdown should be used only as intended #23

Open Jenneh opened 2 years ago

Jenneh commented 2 years ago

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

tonyfast commented 1 year ago

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 commented 1 year ago

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