-
Notifications
You must be signed in to change notification settings - Fork 62.2k
Add Supported Color Models to Basic Writing Syntax #18478
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
Conversation
Automatically generated comment ℹ️This comment is automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.
|
This comment was marked as duplicate.
This comment was marked as duplicate.
@aisgbnok Thanks so much for opening a PR! I'll get this triaged for review ⚡ |
- Improved formatting - Support prefers-color-scheme
This comment was marked as outdated.
This comment was marked as outdated.
I based my syntax on the World Wide Web Consortium's CSS Color Module Level 3. While those links may be helpful, I decided against linking them because I don't think GitHub Docs needs to explain how web colors work. It could also be further confusing because the GitHub supported color models don't support the three hexadecimal characters format, as listed in W3C. I included a note for the whitespaces, but wasn't sure if I should add one for the HEX requiring six hexadecimal characters. Lines 106 to 110 in 8ab4cf6
I think it's fine because the syntax column that I have only lists the six-character version. If someone tries three characters they should realize pretty quickly that six are required. |
@aisgbnok Thanks so much for including all of this helpful information into the decisions you made 😍 We don't support |
Thanks, @janiceilene, I have replaced the |
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.
Hi @aisgbnok - This looks really good. Thanks.
However, when I tried this out for myself in a readme it didn't work. I used the markdown you give as an example and it rendered like this:
I was expecting it to render as shown in your new section:
You can see this here: https://github.com/hubwriter/hubwriter-test/blob/master/README.md
I tried this in Chrome, Firefox, and Safari but the colored circle you show didn't show up.
Could you clarify how/where you get this markdown to render as shown in your images? Thanks
@hubwriter, unfortunately, it seems like it only renders in Issue/PR descriptions or comments. I should have tested in a readme as well.
Should we scratch the whole section or add a warning note that it does not work in markdown files but will work elsewhere? Apologies for this oversight, thanks! |
The background color should be |
@aisgbnok - Ah, that makes sense. Thanks. I think it would be a shame to lose this entirely. I'd suggest making a couple of changes. Change:
to:
And also change:
to:
|
Co-authored-by: hubwriter <hubwriter@github.com>
@hubwriter, thanks, I committed your suggestions. |
@aisgbnok - That's great. Many thanks for your help. 🎖️ I've approved this to be merged. We have a merge freeze on the repo until 11 July but we'll get this merged/published after that. 🚀 |
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Why:
Closes #17312
What's being changed (if available, include any code snippets, screenshots, or gifs):
Added documentation for the three supported color models (HEX, RGB, HSL) in a table similar to the "Styling text" table.
Check off the following:
Writer impact (This section is for GitHub staff members only):