squidfunk / mkdocs-material

Documentation that simply works
https://squidfunk.github.io/mkdocs-material/
MIT License
20.72k stars 3.52k forks source link

New darker slate theme feels like it lacks contrast/readability #6061

Closed johnthagen closed 1 year ago

johnthagen commented 1 year ago

Context

Disclaimer: I realize this issue is highly subjective, but I do hope it provides meaningful feedback. ❤️

Description

9.4.0 changed:

Improved slate color scheme (dark mode) - now even darker

I realize this is subjective, but I feel the changes make it harder to read because normal text is so faint and grey now. Also bolded text is much brighter relatively, which makes it pop out almost too much.

I'm all for darker themes in general, but I would prefer keeping the contrast/brightness high for normal text and text to be closer to white so that it is readable easily, even for people with poorer eyesight.

Perhaps it would be useful to have a "muted-slate" or "vivid-slate" option that is closer to the previous?

Related links

Use Cases

Anyone using slate theme (which, normally I thought was a great, simple default dark theme).

I first noticed this issue when we updated to 9.4.0 on a work project, but then went to one of my open source projects to show as an example

Visuals

Personally, I find the faded text color doesn't pop and read as well. Also note how much brighter bold text is, which I felt like is now more of a "highlight" than a "bold" in standard Markdown terms.

Screenshot 2023-09-21 at 2 03 42 PM

Before submitting

squidfunk commented 1 year ago

Thanks for reporting. In fact, I find it harder on the eyes when contrast is too bright. We can increase the contrast slightly, but we're not going to increase it to the value we had before. As the background is darker now, it is also okay to make the text a little fainter. Bold text is brighter so it has the same contrast when viewing in light mode. Otherwise, bold text is lost. That being said, we'll increase the value slightly, but you can also add a single line to revert back to the old style.

[data-md-color-scheme=slate] {
  --md-default-fg-color: hsla(var(--md-hue), 15%, 90%, 1);
}

Themes are always subjective 😉

squidfunk commented 1 year ago

As an addendum: text in GitHub's dark theme is also not white. White text on dark background is too hard too read.

saltydk commented 1 year ago

I agree with OP that this makes things harder to read at first glance, the change was fairly jarring. Not possible to just implement more themes instead of making such large changes?

squidfunk commented 1 year ago

We could've implemented a new color scheme, but this would increase the size of the payload at no upside, since we only changed some tints. Personally, I was sick of the old color theme, which is why I adapted it to something I believe is much better than what we had before. Yes, it is subjective after all.

Please know that when you maintain a project of this size any change you make is unpopular, but we have big plans and need to move this project forward to keep it sharp, so we have to change things. The previous dark scheme did not go well with certain color combinations, e.g. black, so we adapted it, and to have actually more overall contrast (link colors, tabs, etc.). We'll slightly increase the contrast of the text and will have a better situation as before.

That being said, we put great emphasize on customization, and it's actually so easy to adjust with a few lines of CSS (as noted in my last comment), that you can revert back to the old colors, or even better: build your own custom color theme!

squidfunk commented 1 year ago

For comparison, here's the text color that GitHub uses (top) vs. the one that we currently use:

Bildschirm­foto 2023-09-22 um 12 28 53

Nonetheless, I'll slightly tweak the colors again, so they fit together a little better ☺️

squidfunk commented 1 year ago

I've adjusted the colors in c9e4a5e26513d34a5438d6c0268a6344814bd48f.

This issue is now considered resolved. If you wish to tweak the colors – go ahead, it is super simple! This is our new dark mode that we regard superior to the prior one, which was too light and had problems with contrast.

Before

screenshot-squidfunk-github-io-mkdocs-material-getting-started-1695384114879

After

screenshot-localhost-8000-mkdocs-material-getting-started-1695384121468

johnthagen commented 1 year ago

Thanks @squidfunk. I was in the process of posting that your idea to compare to GitHub's dark theme as a reference is a great idea!

Here was a comparison side by side between the 9.4.0 dark theme and GitHub's dark theme, showing the difference is background and foreground color & contrast.

Screenshot 2023-09-22 at 8 07 09 AM

As always thanks for the awesome tool you've created and for your feedback and work. ❤️

squidfunk commented 1 year ago

I'm using dark dimmed which is closer to what the slate theme is now 😉

squidfunk commented 1 year ago

Released as pat of 9.4.1.

vedranmiletic commented 1 year ago

@squidfunk good work, I particularly like

Removed extra styling for bold text (that was an experiment)

johnthagen commented 1 year ago

@squidfunk Just wanted to follow up that we upgraded to 9.4.1 and want to report that the new tweaked slate theme feels a lot better at first glance than 9.4.0 -- thank you for your thoughtful consideration and quick updates. ❤️