I have a README.md
file for my project underscore-cli, and I want to document the --color
flag.
Currently, the only way to do this is with a screenshot (which can be stored in the project repository):
But screenshots aren't text, preventing readers from copy/pasting the command in the screenshot. They're also a pain to create / edit / maintain, and are slower for browsers to load. The modern web uses text styles, not a bunch of rendered images of text.
While some Markdown parsers support inline HTML styling, GitHub doesn't; this doesn't work:
<span style="color: green"> Some green text </span>
This doesn't work:
<font color="green"> Some green text </font>
Best Answer
One way to add color to a README is by utilising a service that provides placeholder images.
For example this Markdown can be used:
To create a list of any colors you like:
#f03c15
#c5f015
#1589F0