Quick Start table style

phseiff commented 3 years ago

This is a minor, stylistic thing in the README that I thought about, not really worth raising an issue about it, but I didn't come to a conclusion myself, so I figured I would post it here to possibly get some second opinions about it.

As it is now, every second row in the table in which the Quick Start section is arranged (this one) is gray, and every second one is white, because this is how GitHub's CSS styles tables. This comes with...

...an advantage: rows are easy to tell apart, and the table is visually more distinct from its non-table surroundings.
...a disadvantage: every second row (the gray ones) has exactly the same color as the code field within it, so the code fields in every second row are visually indistinguishable from their surroundings, which is really suboptimal.
...a second (maybe?) disadvantage: I'm not sure if it is desirable to highlight every second row, since there is not much of a difference between even and uneven rows, and this is not even intended to be a "real" table (in the classical sense of a table) anyway, so this coloring might even be confusing and tangential to its purpose and meaning.

I figured out that, since I am using a HTML table rather than a markdown table in the markdown file, it's possible to make every row white (rather than gray) by inserting empty rows between every non-empty row. These empty rows will then be colored gray, which won't have any effect since they'll be invisible anyways.

My question: Do you think that this would look better/ more intuitive than it currently does, or do the advantages of having every second row gray outnumber the disadvantages? You can answer with a thumbs-up for yes/ thumbs-down for no, or leave a comment, if you have an opinion on this.

Note that I might apply this to other tables in future repositories as well, so this is partially a general question and not just me over-optimizing this project's README, in case you are worrying about that :)

phseiff commented 3 years ago

I created a branch where this change can be seen. You can look here for comparison, to see how it'd look if I where to change the table according to this issue's suggestion.

phseiff commented 3 years ago

I got feedback from @yeldiRium on the branch and merged it now (https://github.com/phseiff/gender-render/commit/e34f31f7770965c243fdb64f1df57a76ce581728).

phseiff / gender-render

Quick Start table style #8