如何为Github添加颜色';s README.md文件
我的项目有一个如何为Github添加颜色';s README.md文件,github,colors,markdown,github-pages,readme,Github,Colors,Markdown,Github Pages,Readme,我的项目有一个README.md文件,这是一个在命令行上破解JSON和JS的非常好的工具,我想记录--color标志 目前,唯一的方法是使用屏幕截图(可存储在项目回购中): 但是屏幕截图不是文本,这会阻止读者在屏幕截图中复制/粘贴命令。它们的创建/编辑/维护也很麻烦,而且浏览器加载速度较慢。现代网络使用文本样式,而不是一堆文本的渲染图像 虽然一些标记解析器支持内联HTML样式,但Github不支持 这不起作用: 一些绿色文本 这不起作用: 一些绿色文本 下面,你会发现一些有创意的技巧的
README.md
文件,这是一个在命令行上破解JSON和JS的非常好的工具,我想记录--color
标志
目前,唯一的方法是使用屏幕截图(可存储在项目回购中):
但是屏幕截图不是文本,这会阻止读者在屏幕截图中复制/粘贴命令。它们的创建/编辑/维护也很麻烦,而且浏览器加载速度较慢。现代网络使用文本样式,而不是一堆文本的渲染图像
虽然一些标记解析器支持内联HTML样式,但Github不支持 这不起作用:
一些绿色文本
这不起作用:
一些绿色文本
下面,你会发现一些有创意的技巧的聪明答案:
- []使用emojis作为彩色项目符号(您无法为GitHub
文件中的纯文本着色。但是,您可以使用下面的标记为代码示例添加颜色 要做到这一点,只需将这些示例之类的标记添加到README.md文件中: ```json // code for coloring ``` ```html // code for coloring ``` ```js // code for coloring ``` ```css // code for coloring ``` // etc. ```json //着色代码 ``` ```html //着色代码 ``` ```js //着色代码 ``` ```css //着色代码 ``` //等等。 不需要“pre”或“code”标签README.md
GitHub用于识别和突出显示语法-您可以在中找到支持的语言(以及它们的标记关键字)的完整列表。不幸的是,这目前是不可能的 没有提到“颜色”、“css”、“html”或“样式” 虽然一些降价处理器(例如中使用的处理器)允许使用HTML,例如
,但GitHub放弃了任何HTMLWord up
如果您必须在自述文件中使用颜色,您的readme.md可以简单地将用户引用到readme.html。当然,这一点的权衡是可访问性。我倾向于同意Qwertman的观点,即目前无法在GitHub标记中为文本指定颜色,至少不能通过html GitHub确实允许一些HTML元素和属性,但只允许某些HTML元素和属性(请参阅他们关于它们的文档)。它们确实允许
和p
标记,以及div
属性。但是,当我尝试在GitHub上的标记文档中使用它们时,它不起作用。我尝试了以下(以及其他变体),但它们不起作用:color
这是一些红色文本。
这是一些文本!
这些是红色单词。
正如Qwertman所建议的,如果您确实必须使用颜色,您可以在README.html中使用颜色,并将其引用。作为渲染光栅图像的替代方法,您可以嵌入SVG文件:<a><img src="http://dump.thecybershadow.net/6c736bfd11ded8cdc5e2bda009a6694a/colortext.svg"/></a>
您可以使用
语言标记生成一些彩色文本:diff
但是,它将它添加为一个新行,以```diff - text in red + text in green ! text in orange # text in gray @@ text in purple (and bold)@@ ```
开头或以-+!#
开头和结尾@
这一问题在中提出,但自那时(2014年)以来,他们的决定没有任何变化。值得一提的是,您可以使用占位符图像服务在自述文件中添加一些颜色。例如,如果您想提供颜色列表供参考:
产生:- ![#f03c15](https://via.placeholder.com/15/f03c15/000000?text=+) `#f03c15` - ![#c5f015](https://via.placeholder.com/15/c5f015/000000?text=+) `#c5f015` - ![#1589F0](https://via.placeholder.com/15/1589F0/000000?text=+) `#1589F0`
#f03c15
#c5f015
#1589F0
- text:要显示的字符串
- 字体:不使用,因为我在这个演示中只使用了Arial.ttf
- fontSize:一个整数(默认为12)
- 颜色:6个字符的十六进制代码
使用此代码:$rgbColors = ConvertTool::convertHexColorToRgb($hexColor);
在这种情况下,十六进制颜色的长度必须正好为6个字符(不要将哈希符号(#)放在它前面)$rgbColors = sscanf($hexColor, "%02x%02x%02x");
注意:最后,我没有使用这项服务,因为我发现字体很难看,而且更糟糕:无法选择文本。但为了讨论这个问题,我认为这段代码值得分享…在撰写本文时,Github Markdown会呈现颜色代码,如
(请注意背面标记!)使用颜色预览。只需使用颜色代码并用背景标记将其环绕 例如: 变成`ffffff`
以下是您可以编写彩色文本的代码危险
红色
!/bin/bash #将ansi彩色终端输出转换为github标记 #为了给github上的文本上色,我们使用红色等 #取决于:啊哈,xclip #许可证:CC0-1.0 #注意:某些工具可能需要“--color=always”以外的其他参数` #示例用法:colors-to-github.sh diff a.txt b.txt cmd=“$1” 转移 ( 回声“ $cmd--color=始终“$@”2>&1| aha--无标题 回声“ ) \
|sed-E的/如果您对这种有限的颜色和形状(尽管它们在不同的操作系统/浏览器中看起来可能不同)感到满意,那么这些表情符号也很有用,这是一种需要外部服务的替代方案,可能有一天会出现这种情况,并且使用表情符号的想法来自:
如果你不能通过降价给你的文本上色,嵌入一个屏幕截图会起作用吗?是的。我在发布这个问题后就想到了。我认为屏幕截图可能是我最好的回退答案,尽管它显然不理想。所以现在还不可能在降价文件中为文本添加颜色?不,还有2014年7月的ffsSee:@nielsabilidgaard谢谢!:)答案是你至少不能在GitHub.md文件中给纯文本上色$rgbColors = ConvertTool::convertHexColorToRgb($hexColor);
$rgbColors = sscanf($hexColor, "%02x%02x%02x");