Skip to content

Document markdown color rendering #17312

@aisgbnok

Description

@aisgbnok

Code of Conduct

What article on docs.github.com is affected?

One of the following:

What part(s) of the article would you like to see updated?

I have noticed recently that wrapping color in markdown code syntax renders the color. I'm not sure if this is new behavior, but either way, I don't believe this is documented anywhere. I thought it was cool, and it would be nice to have this documented.

I'm not entirely sure the best location to put this. You can see my suggestions above, but I don't think this is extensive enough to have its own page? I wouldn't mind writing and opening a PR documenting this, but I first would love some feedback as to where this would be best placed. Thanks!

Additional information

Below you can see an example list that shows colors being rendered when wrapped in markdown code syntax. Note that keeping a list of supported colors doesn't have to be in the documentation. I just wanted to list them all out to see what was working.

Supported

  • HEX #3fb950
  • RGB rgb(255, 233, 0)
  • HSL hsl(128, 49%, 49%)

Unsupported

  • HSV hsv(128, 66%, 73%)
  • CMYK cmyk(66%, 0%, 57%, 27%)
  • HSB hsb(128, 49%, 49%)
  • HSI hsi(128, 42%, 43%)
  • HWB hwb(128, 25%, 27%)
  • NCol G14, 25%, 27%
  • CIELAB CIELab(66.77, -55.25, 42.98)
  • CIEXYZ xyz(20.8459, 36.3325, 13.504)
  • VEC4 (0.25f, 0.73f, 0.31f, 1f)

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamget startedContent related to "Getting Started" doc sethelp wantedAnyone is welcome to open a pull request to fix this issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions