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: enhance colors description table #37811

Merged
merged 1 commit into from
Jan 6, 2023
Merged

Conversation

julien-deramond
Copy link
Member

@julien-deramond julien-deramond commented Jan 5, 2023

Description

This PR suggests to display slightly differently the colors in the second part of the table in https://getbootstrap.com/docs/5.3/customize/color/#colors so that:

  • --bs-xxx, --bs-xxx-rgb and --bs-xxx-bg-subtle are displayed as background colors
  • --bs-xxx-border-subtle is displayed as a big border
  • --bs-xxx-text is displayed as an actual text

Motivation & Context

We struggled to understand this table with @louismaximepiton when he was trying to find a dark/black text color for another PR.

When you have such a goal in mind and that you can directly in https://getbootstrap.com/docs/5.3/customize/color/#colors, there's --bs-dark-text and the text is displayed as white. IMO it's very hard to understand.

Type of changes

  • Enhancement

Checklist

  • I have read the contributing guidelines
  • My code follows the code style of the project (using npm run lint)
  • My change introduces changes to the documentation
  • I have updated the documentation accordingly

Live previews

@julien-deramond julien-deramond mentioned this pull request Jan 5, 2023
81 tasks
@julien-deramond julien-deramond marked this pull request as ready for review January 5, 2023 12:16
@julien-deramond julien-deramond requested a review from mdo January 5, 2023 12:16
@mdo
Copy link
Member

mdo commented Jan 5, 2023

Oh this looks great! Just reviewed in my phone, will check more closely on laptop later today.

Copy link
Member

@mdo mdo left a comment

Choose a reason for hiding this comment

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

Beautiful!

@mdo mdo merged commit d17d2ab into main Jan 6, 2023
@mdo mdo deleted the main-jd-improve-customize-color-doc branch January 6, 2023 03:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants