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: Polish up documentation CSS and font #1552

Merged
merged 2 commits into from
Jan 31, 2025

Conversation

another-rex
Copy link
Collaborator

  • Update font to be more readable, Overpass is much harder to read for dense text, and bold text fades into the background. Use more standard text font of Source Sans Pro (3)
  • Fix code blocks being very hard to read
  • Fix Tables to not have gaps

New version of docs: https://another-rex.github.io/osv-scanner/supported-languages-and-lockfiles/
Old version of docs: https://google.github.io/osv-scanner/supported-languages-and-lockfiles/

@codecov-commenter
Copy link

codecov-commenter commented Jan 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.31%. Comparing base (a3a1fc1) to head (2ce6f5a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1552   +/-   ##
=======================================
  Coverage   69.31%   69.31%           
=======================================
  Files         200      200           
  Lines       19038    19038           
=======================================
  Hits        13196    13196           
  Misses       5135     5135           
  Partials      707      707           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cuixq
Copy link
Contributor

cuixq commented Jan 31, 2025

the new heading looks not bold enough to me - can we improve this?

@another-rex
Copy link
Collaborator Author

Hmm... I think it looks alright? If you look at just the docs https://just-the-docs.com/docs/ui-components/typography/ it's about the same, I can bump up the font weight a bit, but it's supposed to be thin.

@jess-lowe
Copy link
Contributor

I agree with Xueqin - it feels a little unbalanced. I think having the heading 1 font weight matching the heading 2 font weight feels better (so both at 500). That or bring back Overpass just for the headings - I liked that font lol.

@another-rex
Copy link
Collaborator Author

another-rex commented Jan 31, 2025

Reverted the heading fonts to overpass now :) (will take a second to deploy)

Copy link
Contributor

@jess-lowe jess-lowe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@another-rex another-rex merged commit a5d0e2b into google:main Jan 31, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants