我有一个自述文件。md文件用于我的项目underscore-cli,我想记录——color标志。
目前,做到这一点的唯一方法是截图(可以存储在项目存储库中):
但截图不是文本,防止读者复制/粘贴截图中的命令。创建/编辑/维护它们也很麻烦,而且浏览器加载速度较慢。现代网络使用文本样式,而不是一堆渲染的文本图像。
虽然一些Markdown解析器支持内联HTML样式,但GitHub不支持;这行不通:
<span style="color: green"> Some green text </span>
这行不通:
<font color="green"> Some green text </font>
问题是“如何在github readme中为文本上色”
哪一个是困难的/不可能的
跑题:在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
你不能在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文件中找到支持语言的完整列表(以及它们的标记关键字)。