-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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] CSS style improvements #12546
Conversation
For counter-reference though 😅 : https://pradyunsg.me/furo/kitchen-sink/admonitions/ and https://squidfunk.github.io/mkdocs-material/reference/annotations/, the text is smaller They are meant to be "asides" semantically, so I don't know if I agree that they are "equally important" (and I think in general furo is nicer looking and maybe better to follow) If nothing else, the "feature" admonitions on the landing page should still be smaller. The other changes I think are good 👍 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see comment
Re: Font size of admonitions: I believe we're all not experts on typography. I therefore checked what "big sites" do, assuming they have thought about these things. Note GitHub does not reduce the font size in admontions. The same holds for Microsoft Azure docs and Apple developer docs. Based on that, I propose same-size is likely better, but I don't have a strong opinion. |
As a suggestion: - increase paragraph line-height to 1.5 to give text a bit more room to breathe. 1.5 is a common choice in web page typography; e.g. rtd-sphinx-theme, furo and GitHub use this (pydata sphinx theme goes even to 1.65). - Don't shrink the text in admonitions. They are equally important and thus should have the same size as regular paragraphs. - Adapt the border color for all warning/error like admonitions. Warnings had a fixed color that did not fit well to the new admonition style.
Ok, kept them in the smaller font. |
I removed the increase in admonition text size for now, since I really do feel it makes the pages with many admonitions less readable |
As a suggestion: