jothepro / doxygen-awesome-css

Custom CSS theme for doxygen html-documentation with lots of customization parameters.
https://jothepro.github.io/doxygen-awesome-css/
MIT License
1.04k stars 118 forks source link

Search results a tat dark #15

Closed tdegeus closed 3 years ago

tdegeus commented 3 years ago

Still a huge fan! But to business:

I find the text of the search results a tat dark, and I've noticed straining my eyes a bit. What do you think?

Screenshot 2021-04-21 at 19 50 32
jothepro commented 3 years ago

Yep, totally agree. This is a huge problem that I was not able to address yet.

I would like to change a few things about the search results to improve readability:

The problem is that the search results are loaded inside an iframe. Which means that the custom CSS has no control over it's formatting.

The only workaround that I could think of would be to choose a slightly lighter background color, so the readability of the content improves. The problem with a lighter background color: While the black text gets more readable, the blue text gets absolutely unidentifiable. To my eyes black on black is kind of readable if I look very closely, but blue on gray gets a blurry mess and I can hardly make out characters even on close inspection:

That's why I decided to go with the current solution of a relatively dark background. This is not optimal and I welcome every creative solution for that! :)

Maybe there is an easy way of injecting CSS into the search results that I haven't figured out yet?

jothepro commented 3 years ago

Hm I actually have a tip for you that might help a little bit:

The color of the search results (the blue portion of it, not the black) is predetermined by the doxygen color settings. This is my setup, it already makes the blue a bit more vibrant and therefore readable:

HTML_COLORSTYLE_HUE    = 209
HTML_COLORSTYLE_SAT    = 255
HTML_COLORSTYLE_GAMMA  = 113

But you could also choose a different color to improve the contrast (Of course you don't want to choose bright yellow, that's just to show you the effect):

HTML_COLORSTYLE_HUE    = 50
HTML_COLORSTYLE_SAT    = 255
HTML_COLORSTYLE_GAMMA  = 255

Be aware that this has side effects on other ui elements as well (oops the color of the detail level should not be affected and the folder icons have a strange color, I guess that's a bug in my theme) and that it is not not dark mode specific, so the color should work for both dark and light mode.

tdegeus commented 3 years ago

Hi @jothepro . Thanks for your replies. Given the internal limitations I think that the current style is indeed perfectly acceptable. It seems like an issue that should be addressed upstream? In the long terms there seems to be willingness to integrate a dark theme in doxygen, ref https://github.com/doxygen/doxygen/issues/8404 , so maybe in the long term you could consider proposing this theme here to be integrated in doxygen . That would be the perfect opportunity to resolve these issues.

Thanks for the quick-fix. Seems quite ok as a work-around. Though I must admit things are not super urgent for me: I filed this issue because I wish the best for this awesome theme !

jothepro commented 3 years ago

I've found a way to fix this problem in https://github.com/jothepro/doxygen-awesome-css/commit/8739758d46602cf90e95e349731faa2ea7109d8d

I'm simply inverting the entire search results iframe. 👏

I consider this problem as resolved. If you are experiencing issues with my solution, pls re-open the issue!