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

Create website to document color variables #25

Merged
merged 7 commits into from
Oct 8, 2020
Merged

Conversation

colebemis
Copy link
Contributor

@colebemis colebemis commented Oct 7, 2020

📹 Loom video explanation: https://www.loom.com/share/4e2abf846c8c43eabcfaf9fd108aeb58

Problems

It's very difficult to find a list of available color variables.

Solution

This PR adds a mini-docs site to this repo to document the available color variables and their values in different color modes.

👀 Preview: https://primitives-git-docs.primer.vercel.app/

image

@vercel
Copy link

vercel bot commented Oct 7, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/primer/primitives/p5kxcd16d
✅ Preview: https://primitives-git-docs.primer.vercel.app

@colebemis colebemis requested a review from simurai October 7, 2020 19:50
Copy link
Contributor

@simurai simurai left a comment

Choose a reason for hiding this comment

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

😻 Awesome! Especially handy for copy&pasting the CSS variables. Currently I have to "chain" them together by hand.

Some thoughts for future improvements:

  • Yeah, I think it would make sense to have the docs at https://primer.style/primitives. Just to make it clear that it's a separate repo.
  • It might be useful to see how a hex value was defined. Like if it uses the color scale ($blue-200) or if it's a custom color like for border-secondary (lighten($gray-200, 3%)).
  • Would be nice if the box-shadows could be shown in a single row. They are kinda a special case since they include the shadow size/position too.
  • The dark mode column could have a dark background. So that it's more clear if something has a big or low contrast.
  • And some more advanced stuff like search or filter.. where you can click on a color and it shows all the variables that use the same color so you can see how things relate to each other.

@colebemis
Copy link
Contributor Author

@simurai I love those suggestions! ❤️

I updated the background color of the dark mode column 🌚

image

@colebemis colebemis merged commit 63623fe into mkt/color-modes Oct 8, 2020
@colebemis colebemis deleted the docs branch June 11, 2021 21:10
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.

None yet

2 participants