-
-
Notifications
You must be signed in to change notification settings - Fork 59
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
Add backgrounds and borders to admonitions #190
Conversation
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.
I left a few nitpicky comments, and I also have some additional bikeshedding, since the color choice of some admonition seems somewhat arbitrary to me:
attention
seems to belong to the category of "potentially dangerous things that you should pay attention too", alongsideimportant
,caution
,danger
,warning
, anderror
. I would probably place it betweenimportant
andcaution
, color them gray/yellow, and then proceed with orange/red for more dangerous things -- using blue forattention
feels wrong to me.- Similarly
hint
,note
,see also
,tip
are all more neutral admonitions, and for those those I would use a neutral color like gray, blue, or possibly yellow -- green stands out a bit too much IMHO.
We should also check how they look on some real-world example, and see if the colors (and maybe the boxes too) are too distracting. This might actually be the reason why they weren't added in the first place (maybe we should check with the original author too and ask them why they made that choice).
We might also want to leave the bikeshedding for a separate PR (especially if you just copied the colors from another theme) as not to stall this PR.
…ges and conflicts with background-color
Thanks all for the reviews, let's merge and release. We can adjust and iterate the others in the future. |
Only some of the "admonitions" have backgrounds and borders, giving them slightly different indentations:
We're missing backgrounds and borders for most of them:
Other themes have them for all:
Let's also fill in the gaps.
Before
After
Screenshots using this from the Kitchen Sink:
Details