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

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

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

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

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

这行不通:

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

当前回答

向README添加颜色的一种方法是利用提供占位符图像的服务。

例如,Markdown可以使用:

- ![#f03c15](https://placehold.co/15x15/f03c15/f03c15.png) `#f03c15`
- ![#c5f015](https://placehold.co/15x15/c5f015/c5f015.png) `#c5f015`
- ![#1589F0](https://placehold.co/15x15/1589F0/1589F0.png) `#1589F0`

创建一个你喜欢的颜色列表:

# f03c15 # c5f015 # 1589F0

其他回答

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

参考: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

作为渲染光栅图像的替代方案,您可以嵌入SVG文件:

<a><img src="https://dump.cy.md/6c736bfd11ded8cdc5e2bda009a6694a/colortext.svg"/></a>

然后,您可以像往常一样向SVG文件添加颜色文本:

<?xml version="1.0" encoding="utf-8"?>
<svg version="1.1"
     xmlns="http://www.w3.org/2000/svg"
     xmlns:xlink="http://www.w3.org/1999/xlink"
     width="100" height="50"
>
  <text font-size="16" x="10" y="20">
    <tspan fill="red">Hello</tspan>,
    <tspan fill="green">world</tspan>!
  </text>
</svg>

不幸的是,尽管您可以在打开. SVG文件时选择和复制文本,但当嵌入SVG图像时,文本是不可选择的。

演示:https://gist.github.com/CyberShadow/95621a949b07db295000

GitHub默默地增加了对> __Note__和> __Warning__语法的支持:

向README添加颜色的一种方法是利用提供占位符图像的服务。

例如,Markdown可以使用:

- ![#f03c15](https://placehold.co/15x15/f03c15/f03c15.png) `#f03c15`
- ![#c5f015](https://placehold.co/15x15/c5f015/c5f015.png) `#c5f015`
- ![#1589F0](https://placehold.co/15x15/1589F0/1589F0.png) `#1589F0`

创建一个你喜欢的颜色列表:

# f03c15 # c5f015 # 1589F0

你不能在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文件中找到支持语言的完整列表(以及它们的标记关键字)。