Sitecore / jss

Software development kit for JavaScript developers building web applications with Sitecore Experience Platform
https://jss.sitecore.com
Apache License 2.0
262 stars 272 forks source link

Docs - Emphasized Markdown text color is low-contrast and appears de-emphasized #746

Closed sfinevelir closed 2 years ago

sfinevelir commented 3 years ago

Description

Emphasized <em> text in the Markdown documentation is currently styled with color: #7f8c8d; resulting in low-contrast text, especially for text that should have greater emphasis. Firefox's Accessibility tools show a contrast ratio of 3.48, which is below WCAG recommendations for body text (4.5 or greater) and could cause readability issues for low-vision users.

image

image

(See also: https://webaim.org/resources/contrastchecker/ to confirm WCAG issues)

Expected behavior

Emphasized text should appear emphasized by maintaining high color contrast along with the italic font.

Steps To Reproduce

  1. View public-facing documentation (example: https://jss.sitecore.com/docs/techniques/extending-layout-service/layoutservice-static-context-rendering)

Possible Fix

I'll leave specific styling choices in your capable hands, but using a darker gray like the Sitecore brand color #232323 would improve the contrast. Using a heavier font weight would also improve the readability, but to my eye it also feels like that could add too much focus on specific words? This is an example of color: #232323; font-weight: 600;:

image

Your Environment

N/A, public-facing documentation.

Screenshots

See above

CobyPear commented 3 years ago

Thank you for submitting this issue. @ancaemcken Would you mind taking a look at this? I know we looked at lighthouse scores the other day and noticed this was an issue.

addy-pathania commented 2 years ago

Closing as docs are no longer maintained in this repository.