TypeStrong / typedoc

Documentation generator for TypeScript projects.
https://typedoc.org
Apache License 2.0
7.7k stars 697 forks source link

Make default theme icons monochrome, paint them in CSS #1732

Closed KillyMXI closed 2 years ago

KillyMXI commented 3 years ago

Search Terms

Default theme, icon colors, custom CSS

Problem

My code is 100% functions and type aliases. The purple used by the default theme is the most unnatural to human eyes and very poorly readable in dark theme.

I can't change icon colors to more readable ones without significant effort.

Suggested Solution

Make default theme customization more code-friendly. Make icons to be colored via CSS so I could make it more ergonomic with custom CSS alone, by specifying few meaningful variables and not hacking around.

Preferably SVG icons, so they will appear sharp on any DPI screens.


Edit: re-worded.

KillyMXI commented 2 years ago

My docs are now public if anyone curious: https://mxxii.github.io/peberminta/

The acid color of icons, the lack of a link back to GitHub and auto-sorted modules list in the sidebar are the most annoying issues.

Defining CSS variables for more syntax features would've been helpful, even if assigned the same color by default - it'd be much friendlier to customization.

Oh, and navigation marker seems to be pointing at a wrong entry often, so I had to disable that.

Gerrit0 commented 2 years ago

I've legitimately put off responding to this for 4 months since the antagonistic wording for a feature request for an open source project annoys me so much that I have difficulty responding to it with grace.

With 0.23, icons will be defined using a svg, which can be styled via css.

KillyMXI commented 2 years ago

I'm sorry. I'm not trying to attack anyone. I'm not demanding to solve my issues ASAP or at all. I have a bad habit to paint my user experience reports like this. It doesn't work well, but I have ASD and always miss that.

KillyMXI commented 2 years ago

And thank you. typedoc is indispensable tool. I was so focused on expressing all the inconveniences I didn't think how to balance it with all the good that is there as well.