Skip to content

MKdocs Typography, formatting and color improvements #1566

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

Merged
merged 9 commits into from
Apr 8, 2025

Conversation

allisonwhilden
Copy link
Collaborator

@allisonwhilden allisonwhilden commented Apr 7, 2025

Why are these changes needed?

Cleaning up MKDocs styling as per #1530. This doesn't address everything, but below are details of what it fixes.


Improves styling and information hierarchy for all the headers

I updated the styling for H1 - H5. I kept Jersey10 just for limited usage of H1, but made sure it wasn't uppercase. I switched all headers to be full black instead of grey, adjusted the spacing of all of them, and made H2-H5 Jetbrains Mono.

ex. Before/After
image


Improves the colors for dark mode

I tweaked the colors for dark mode to increase the contrast and just look a little more polished.

ex. Before/After
image


Cleans up formatting bugs in the user guide section

There were a number of formatting bugs I found while looking through all of the pages of the user guide section. These included:

Lack of space around a list making it so the list didn't display like a list

image

A H1 used inadvertently elsewhere on the page making it so MKDocs didn't auto-generate an H1 at the top from the front matter

image

A code block that had a code block in it as an output example from an agent which would cause an early end to the code block. I wrapped those code blocks in 4 ticks (````)

image

Simplified the layout of the key features on the home page

The centered text of that length is just really ragged and hard to read. Switched to a vertical stack instead of a horizontal layout. The entire home page will be redesigned soon, but this felt like a nice short-term clean-up

Before/after (please note -- the yellow background at the top wasn't removed. I think there was an error with my local server with accessing some of the assets that I haven't solved yet.)

image

Related issue number

#1530 (but doesn't close it fully)

Checks

@allisonwhilden allisonwhilden self-assigned this Apr 7, 2025
@CLAassistant
Copy link

CLAassistant commented Apr 7, 2025

CLA assistant check
All committers have signed the CLA.

@allisonwhilden
Copy link
Collaborator Author

@harishmohanraj I didn't fully remove Jersey10. Instead, I turned off the uppercase text transform, darkened the color and increased the font size, and reduced it to only being used on H1. I used Jetbrains Mono on H2-H6. I think this combo reads nicely, while remaining true to our style and brand. Let me know what you think. Thanks!

@allisonwhilden allisonwhilden requested review from qingyun-wu and removed request for qingyun-ag2 April 8, 2025 05:58
@allisonwhilden
Copy link
Collaborator Author

@harishmohanraj @qingyun-wu I have fixed all the checks and added more details above about my changes. Review when you get a chance and let me know what you think and if we can get this ready to merge. Thanks!

@davorrunje
Copy link
Collaborator

Looks great!

@davorrunje davorrunje self-requested a review April 8, 2025 07:10
@harishmohanraj
Copy link
Collaborator

harishmohanraj commented Apr 8, 2025

Hi @allisonwhilden, The font combination looks really good on the website. I have made a couple of minor css changes to your PR.

  • Reduced the h1 font size from 3 rem to 2 rem. It looked way too large.
  • Fixed a small css issue in use stories page.

@harishmohanraj harishmohanraj enabled auto-merge April 8, 2025 11:35
@harishmohanraj harishmohanraj added this pull request to the merge queue Apr 8, 2025
Merged via the queue into main with commit 21a1aa6 Apr 8, 2025
16 checks passed
@harishmohanraj harishmohanraj deleted the allison/mkdocs-typography-cleanup branch April 8, 2025 11:40
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.

4 participants