You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
+1000, which is a roughly accurate summation of six years worth of continuous +1 posts on issue #369, most of which weren't noticed due to that issue being closed for most of that time. (I'm exaggerating only slightly; the real number is 76 posts)
#1478
Open
Pkanjai opened this issue
May 30, 2021
· 4 comments
+1000, which is a roughly accurate summation of six years worth of continuous +1 posts on issue #369, most of which weren't noticed due to that issue being closed for most of that time. (I'm exaggerating only slightly; the real number is 76 posts)
Color is an important design feature for many CLI tools, including my underscore-cli tool for hacking on JSON data, and thus, it's important to be able to include properly colored output examples in the documentation.
Currently, the ONLY way to accomplish this is with a screenshot:
Screenshots are inferior to natively colored text. Beyond the minor inconveniences of being cumbersome to create / edit / maintain, and slower for browsers to load, screenshots thwart readers from copy/pasting key snippets of text, such as the command that was executed in the screenshot -- this makes the documentation less usable, and the potential work-arounds are all very ugly.
Another use-case from issue #369: There's a reason you support auto-colorization of code blocks --- coloring text is crucial for facilitating our eyes to parse it faster. However, there's no fallback story for tail languages and other structured text formats that aren't in your list.
Many, many projects would benefit from being able to tastefully color the structured text in their documentation.
👍 If you can build a proprietary markdown extension that builds tables, and already support html tags, it should be relatively simple to whitelist a <tag style="color:... attribute. Another markdown extension like |color:#123 my text| would also be great if securely parsing html attributes is a concern. It's too bad this feature request has been ignored for so long.
On Mon, 1 Nov 2021, 23:54 parkerault, ***@***.***> wrote:
👍 If you can build a proprietary markdown extension that builds tables,
and already support html tags, it should be relatively simple to whitelist
a <tag style="color:... attribute. It's too bad this feature request has
been ignored for so long.
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#1478 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/ARTGKQLJGJZTHLB3V4DZEVDUJ2EZPANCNFSM45Y4LZUQ>
.
+1000, which is a roughly accurate summation of six years worth of continuous +1 posts on issue #369, most of which weren't noticed due to that issue being closed for most of that time. (I'm exaggerating only slightly; the real number is 76 posts)
Please fix this and sunset one of my most popular StackOverflow questions (another +358 upvotes and counting): https://stackoverflow.com/questions/11509830/how-to-add-color-to-githubs-readme-md-file
Color is an important design feature for many CLI tools, including my underscore-cli tool for hacking on JSON data, and thus, it's important to be able to include properly colored output examples in the documentation.
Currently, the ONLY way to accomplish this is with a screenshot:
Screenshots are inferior to natively colored text. Beyond the minor inconveniences of being cumbersome to create / edit / maintain, and slower for browsers to load, screenshots thwart readers from copy/pasting key snippets of text, such as the command that was executed in the screenshot -- this makes the documentation less usable, and the potential work-arounds are all very ugly.
Another use-case from issue #369: There's a reason you support auto-colorization of code blocks --- coloring text is crucial for facilitating our eyes to parse it faster. However, there's no fallback story for tail languages and other structured text formats that aren't in your list.
Many, many projects would benefit from being able to tastefully color the structured text in their documentation.
Originally posted by @ddopson in #1440 (comment)
The text was updated successfully, but these errors were encountered: