我有一个自述文件。md文件用于我的项目underscore-cli,我想记录——color标志。

目前,做到这一点的唯一方法是截图(可以存储在项目存储库中):

但截图不是文本,防止读者复制/粘贴截图中的命令。创建/编辑/维护它们也很麻烦,而且浏览器加载速度较慢。现代网络使用文本样式,而不是一堆渲染的文本图像。

虽然一些Markdown解析器支持内联HTML样式,但GitHub不支持;这行不通:

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

这行不通:

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

当前回答

在撰写本文时,GitHub Markdown呈现了像“#ffffff”(注意反引号!)这样的颜色代码,并带有颜色预览。只需使用颜色代码,并用反刻度符号包围它。

例如:

就变成了

其他回答

可以这样做:

! [] (https://img.shields.io/static/v1?label=&message=Ааи&color = green)

在问题、拉请求和讨论中,您可以使用反勾号在句子中显示颜色。反勾号内受支持的颜色模型将显示颜色的可视化。

参考:https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax # supported-color-models

不幸的是,这目前是不可能的。

GitHub Markdown文档没有提到“颜色”,“CSS”,“HTML”或“样式”。

而一些Markdown处理器(例如在Ghost中使用的)允许HTML,例如<span style="color:orange;>Word up</span>, GitHub's丢弃任何HTML。

如果你必须在自述中使用颜色,你的自述。md文件可以简单地将用户引用到README.html文件。当然,这样做的代价是可访问性。

你不能在GitHub README中为纯文本着色。md文件。但是,您可以使用下面的标记为代码示例添加颜色。

要做到这一点,只需添加标签,如这些示例到您的README。md文件:

```json
   // code for coloring
```
```html
   // code for coloring
```
```js
   // code for coloring
```
```css
   // code for coloring
```
// etc.

不需要“pre”或“code”标签。

这在GitHub Markdown文档中有介绍(大约在页面的一半,有一个使用Ruby的示例)。GitHub使用Linguist来识别和突出显示语法-你可以在Linguist的YAML文件中找到支持语言的完整列表(以及它们的标记关键字)。

你可以使用diff语言标签来生成一些彩色文本:

```diff
- text in red
+ text in green
! text in orange
# text in gray
@@ text in purple (and bold)@@
```

但是,它将其添加为以- + !开头的新行。#或以@@开头和结尾

这个问题是在GitHub标记#369中提出的,但从那时起(2014年)他们就没有做出任何改变。