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

Increase text contrast on website by using full black instead of grey text. #1334

Closed
1 task done
HonkingGoose opened this issue Apr 1, 2019 · 5 comments
Closed
1 task done

Comments

@HonkingGoose
Copy link
Contributor

Please make sure you are NOT reporting a problem about git itself

  • This is not an issue about
    • the Git documentation (a.k.a. man/help pages, i.e. anything with a URL starting with https://git-scm.com/docs), which should be raised with the community,
    • the contents of the Pro Git book (i.e. anything with a URL starting with https://git-scm.com/book or its PDF versions), which should be raised at progit/progit2.
    • Git itself, which should also be raised with the community, or
    • Git for Windows, which should be raised at git-for-windows/git.
    • and is actually about the website itself (e.g. website-specific content, JS, or CSS that doesn't seem to be doing its job correctly).

Issue description:

Some text on the website is harder to read, because it uses a grey text instead of a full black text.

Examples of grey text:

https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control the text of the Pro Git 2 book is rendered in grey.

https://git-scm.com/ The text that's under the "About", "Documentation", "Downloads", and "Community" sections. The text next to the Pro Git book thumbnail.

Suggested improvement:

Change the markup/html/css/JS/whatever so that it uses a full black color for all text.

@pedrorijo91
Copy link
Member

@tarebyte another one to have into account on the redesign #1179

@HonkingGoose thanks for reporting the issue. There's currently an effort to re-design the website (#1179) so this will be considered on that probably.

But if you are able to work on a quick solution and submit a PR I think we may be able to land it in the meanwhile

@HonkingGoose
Copy link
Contributor Author

Hi @pedrorijo91 thanks for your comment. 😄

It would be very nice indeed to have a solid black color. So I do hope it will be considered in the re-design of the site.

As for me helping out with a quick-fix for the text: I don't know HTML/CSS/JS yet, and I don't know how this website is structured yet. So I'm not able to help on this issue. But thanks for the offer of letting me help. I'll keep that in mind for when I do know how those things work. 👍

@jasonlong
Copy link
Member

Thanks for the issue @HonkingGoose. Full black text definitely isn't necessary or even desirable normally.

The text you mention already far exceeds the recommended contrast ratio for accessibility standards. For example, the book content (and all other similarly formatted pages) has a contrast ratio of 9.12 which is a AAA rating.

The new design will, of course, also be mindful of these a11y recommendations.

@HonkingGoose
Copy link
Contributor Author

Hi @jasonlong Thanks for the detailed comment, I'm learning new stuff here. 😄 I didn't know that full black is not desirable. And having seen the examples, it makes more sense to use a dark grey.

I'll take your word on the fact the current text already has a good contrast ratio.

I'm making the assumption here that https://a11yproject.com/ uses the recommended color and contrast for their text. Their text is easy for me to read. So it must be something else apart from color/contrast that is causing issues with reading the smaller text on the git-scm site.

@jasonlong
Copy link
Member

Yeah one of the things I'm excited about with the new design is having a larger font size. This alone will most certainly help with readability.

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

No branches or pull requests

3 participants