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

[Docs]: Dank Mono is hard to read as someone visually and cognitively impaired #873

Closed
ScottAwesome opened this issue Dec 4, 2021 · 11 comments
Labels
📚 docs Related to documentation changes

Comments

@ScottAwesome
Copy link

What problem is this solving

Would like to make code examples more accessible for others with visual and cognitive impairments

Proposed solution

Is it possible to use a different font from dank mono or increase the contrast of the theme? JetBrains Mono has good ligature support, as does Fira Code

Describe alternatives you've considered

I tried to just modifiy this in my browser, and this actually proved to be quite complicated.

I would have to

  • Install a 3rd party extension
  • Target the code examples with CSS
  • Then switch its font

I did try toggling some accessibility settings in Chrome, and this did not help. I have to increase my font size instead for it to be more readable

I'm sorry if I'm being a nuisance here 😢 I really like the docs and pinia, you guys are doing great work. I'm just having the hardest time reading the docs with this font, even in dark mode

@posva
Copy link
Member

posva commented Dec 4, 2021

The docs theme will change in the future and include a different font. The cursive seems to be more difficult to read for non European. So this is already planned for the near future.
I need to ask though: what makes dank mono hard to read while other fonts like fire font do not?

@posva posva added 📚 docs Related to documentation changes and removed feature request labels Dec 4, 2021
@ScottAwesome
Copy link
Author

The docs theme will change in the future and include a different font. The cursive seems to be more difficult to read for
non European. So this is already planned for the near future.
I need to ask though: what makes dank mono hard to read while other fonts like fire font do not?

@posva I can only speak for me here, with that said:

Its the cursive that is the biggest issue I've had, even though ligatures can add emphasis, Fira Code and JetBrains Mono don't have heavily pronounced cursive type, in my experience. Cursive in most fonts like this also tend to have letters tightly spaced together, which can compound the problem

@r-priyam
Copy link

r-priyam commented Dec 6, 2021

To be honest it's all good for me 🙈.. But I agree, cursive seems a bit off the track.

@NarendraPatwardhan
Copy link

@ScottAwesome, I am not visually or cognitively impaired and don't have a problem with cursive in general. However, this particular font makes it extremely difficult to process what's written in the context of code.

@vlazar
Copy link

vlazar commented Dec 13, 2021

Not asking for any particular font/style, just a feedback for clarity. I have astigmatism and it seems light font is what makes it most difficult to read for me. Not as bad as lights in the night, but still harder to focus on.

Code examples are font-weight: 400 which I imagine must look very pleasant to read for someone with good vision though. Tried to change it to font-weight: 600 and it makes cursive easier to read for me ( I know people with good vision find such bold fonts mostly terrible). Still letters like s and f are harder to parse.

@posva
Copy link
Member

posva commented Dec 28, 2021

Added to #829

@posva posva closed this as completed Dec 28, 2021
@posva posva mentioned this issue Dec 28, 2021
20 tasks
@rtek
Copy link

rtek commented Apr 17, 2022

Thanks for this - its jarring to read code that switches between normal looking glyphs and cursive.

In the mean time id recommend using chrome source overrides for pinia.vuejs.org/dank-mono.css with an empty file.

image

@azu
Copy link

azu commented Jun 2, 2022

I met same issue and I could not read the document.
Temporary workaround, I written Greasemonkey/Violentmonkey script to avoid this issue:
https://gist.github.com/azu/e37664f183ef1dd737397992d83d320b

@snowsunny
Copy link

snowsunny commented Jun 9, 2022

I think the problem is happening to non-native English speakers too, like me... 😔 🇯🇵

How I fixed it: https://chrome.google.com/webstore/detail/user-javascript-and-css/nbhcbdghjpllgmfilhnhkllmkecfmpld
image

:root {
	--code-font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New", monospace;
}

@leegee
Copy link

leegee commented Jul 14, 2022

Very disappointed to see this ticket "closed as completed".

image

The comment in the code is barely visible because of the lack of contrast, and the barely legible because of the nature of the cursive.

I really want to use, and convince my teams to use, Pinia, but the lack of docs makes it hard, and the style of the docs means they cannot be used by anyone with a visual impairment (such as myself).

@JasonGrass
Copy link

JasonGrass commented Aug 23, 2022

there is a temporary method: Workaround for https://github.com/vuejs/pinia/issues/873

you can use it in tampermonkey

// ==UserScript==
// @name        pinia: clean document
// @namespace   https://pinia.vuejs.org/
// @match       https://pinia.vuejs.org/*
// @grant       none
// @version     1.0
// @author      -
// @description Remove unreadable web fonts style
// @run-at      document-end
// ==/UserScript==
document.documentElement.setAttribute("style", `--code-font-family: source-code-pro, Menlo, Monaco, Consolas, "Courier New", monospace`);

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 docs Related to documentation changes
Projects
None yet
Development

No branches or pull requests

10 participants