如何给GitHub的README.md文件添加颜色

526

我的项目 underscore-cli 有一个 README.md 文件,我想要记录 --color 标志。

目前,唯一的方法是使用截图(可以存储在项目仓库中):

example.png

但是截图并非文本,使阅读者无法复制/粘贴其中的命令。它们也很难创建/编辑/维护,并且加载速度比较慢。现代的网页使用文本样式,而不是文本的渲染图像。

虽然一些Markdown解析器支持内联HTML样式,但GitHub不支持;这种方式不起作用:

<span style="color: green"> Some green text </span>

这个不起作用:

<font color="green"> Some green text </font>

2
如果您无法通过Markdown着色文本,嵌入屏幕截图是否可行? - girasquid
1
目前还无法在Markdown文件中添加文本颜色吗? - Nam Nguyen
2
不行 - 这是2014年7月,真是该死。 - lfender6445
2023解决方案 ${\textsf{\color{lightgreen} 你好,世界!}}$ - undefined
显示剩余5条评论
23个回答

-2

2
目前你的回答不够清晰。请编辑并添加更多细节,以帮助其他人理解它如何回答所提出的问题。你可以在帮助中心找到有关如何撰写好答案的更多信息。 - Community

-4

问题是“如何在GitHub自述文件中着色文本”
这是困难/不可能的

离题:在GitHub问题中,我们可以使用

<span color="red">red</span>

例子:

#!/bin/bash

# Convert ANSI-colored terminal output to GitHub Markdown

# To colorize text on GitHub, we use <span color="red">red</span>, etc.
# Depends on:
#   aha: convert terminal colors to html
#   xclip: copy the result to clipboard
# License: CC0-1.0
# Note: some tools may need other arguments than `--color=always`
# Sample use: colors-to-github.sh diff a.txt b.txt

cmd="$1"
shift # now the arguments are in $@
(
    echo '<pre>'
    $cmd --color=always "$@" 2>&1 | aha --no-header
    echo '</pre>'
) \
| sed -E 's/<span style="[^"]*color:([^;"]+);"/<span color="\1"/g' \
| sed -E 's/ style="[^"]*"//g' \
| xclip -i -sel clipboard

3
这篇文章被其他人downvote了,因为Github的markdown模块不支持那种彩色文本标签,但我喜欢这个自动转换脚本。如果用Ghost的markdown解析器,或者如果Github修复 https://github.com/github/markup/issues/1440 ,那么这个脚本是可行的。 - Dave Dopson
1
这里有一个在Github上的演示。<span color="red">红色文本</span>等在Github上是有效的。我唯一看到的问题是:没有设置背景颜色的办法。 - milahu
需要解释一下。例如,脚本在什么环境下运行 - 例如,“xclip”似乎高度依赖于系统?它在哪个系统(包括版本)上进行了测试?Linux / Ubuntu?请通过编辑(更改)您的答案来回复,而不是在此处发表评论(不要添加“编辑:”,“更新:”或类似内容 - 答案应该看起来像今天写的)。 - Peter Mortensen

-6

这里是你可以编写的文本着色代码:

<h3 style="color:#ff0000">Danger</h3>

2
你正在编写一个标准的HTML标签,但这在GitHub上不起作用。 - JΛYDΞV

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接