我有一个自述文件。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”(注意反引号!)这样的颜色代码,并带有颜色预览。只需使用颜色代码,并用反刻度符号包围它。

例如:

就变成了

其他回答

现在自2022年5月起,Github可以接受Markdown上的LATEX代码,所以你可以在$$$$块内使用\color{namecolor},如下例所示:

基本

Code Appearing
$${\color{red}Red}$$ $${\color{red}Red}$$
$${\color{green}Green}$$ $${\color{green}Green}$$
$${\color{lightgreen}Light \space Green}$$ $${\color{lightgreen}Light \space Green}$$
$${\color{blue}Blue}$$ $${\color{blue}Blue}$$
$${\color{lightblue}Light \space Blue}$$ $${\color{lightblue}Light \space Blue}$$
$${\color{black}Black}$$ $${\color{black}Black}$$
$${\color{white}White}$$ $${\color{white}White}$$

不止一种颜色

代码

$${\color{red}Welcome \space \color{lightblue}To \space \color{orange}Stackoverflow}$$

可视化

$${\color{红色}欢迎\space \color{浅蓝色}到\space \color{橙色}Stackoverflow}$$

这段代码在Github:

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

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

可能不是问题的确切答案,但当我处于OP的情况下,我正在寻找下面的解决方案:

简单地用:

[![](https://img.shields.io/badge/github-blue?style=for-the-badge)](https://github.com/hamzamohdzubair/redant)
[![](https://img.shields.io/badge/book-blueviolet?style=for-the-badge)](https://hamzamohdzubair.github.io/redant/)
[![](https://img.shields.io/badge/API-yellow?style=for-the-badge)](https://docs.rs/crate/redant/latest)
[![](https://img.shields.io/badge/Crates.io-orange?style=for-the-badge)](https://crates.io/crates/redant)
[![](https://img.shields.io/badge/Lib.rs-lightgrey?style=for-the-badge)](https://lib.rs/crates/redant)

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

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