我有一个自述文件。md文件用于我的项目underscore-cli,我想记录——color标志。
目前,做到这一点的唯一方法是截图(可以存储在项目存储库中):
但截图不是文本,防止读者复制/粘贴截图中的命令。创建/编辑/维护它们也很麻烦,而且浏览器加载速度较慢。现代网络使用文本样式,而不是一堆渲染的文本图像。
虽然一些Markdown解析器支持内联HTML样式,但GitHub不支持;这行不通:
<span style="color: green"> Some green text </span>
这行不通:
<font color="green"> Some green text </font>
你不能在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文件中找到支持语言的完整列表(以及它们的标记关键字)。
我倾向于同意M-Pixel的观点,目前不可能在GitHub Markdown内容中为文本指定颜色,至少不能通过HTML。
GitHub确实允许一些HTML元素和属性,但只允许某些元素和属性(参见他们的HTML消毒文档)。他们允许p和div标签,以及颜色属性。然而,当我尝试在GitHub上的Markdown文档中使用它们时,它不起作用。我尝试了以下方法(在其他变体中),但它们都不起作用:
<p style='color:red'>这是一些红色的文字
<font color="red">这是一些文字!< / font >
这些是<b style='color:red'>红色单词</b>。
正如M-Pixel所建议的,如果你真的必须使用颜色,你可以在README.html文件中这样做,并将它们引用到它。