如何在markdown中突出显示bash/shell命令？

Question

如何突出显示 Markdown 文件中的 Bash/shell 命令？

---

例如，为了突出显示

js

，我写：

```js
function () { return "This code is highlighted as Javascript!"}
```

为了突出显示 HTML 代码，我使用

```html

。

我们如何突出显示 Bash/shell 命令？

Answer 1

如果您希望突出显示用户看到的 shell 会话命令序列（带有提示，而不仅仅是假设的脚本文件的内容），那么目前使用的正确标识符是 console:

```console
foo@bar:~$ whoami
foo
```

Answer 2

这取决于 Markdown 渲染引擎和 Markdown 风格。这没有标准。例如，如果您指的是 GitHub 风格的 Markdown，那么

shell

应该可以正常工作。别名为

sh

、

bash

或

zsh

。您可以在此处找到可用语法词法分析器的列表。

Answer 3

我在Markdown Cheatsheet找到了很好的描述：

代码块是 Markdown 规范的一部分，但语法突出显示不是。

但是，许多渲染器（例如 GitHub 和 Markdown Here）支持语法突出显示。支持哪些语言以及这些语言名称的书写方式因渲染器而异。 Markdown Here 支持数十种语言的突出显示（以及非真正的语言，如差异和 HTTP 标头）；要查看完整列表以及如何编写语言名称，请参阅 highlight.js 演示页面。

虽然我找不到任何关于使用

highlight.js

的官方 GitHub 文档，但我测试了很多语言并且似乎可以工作

查看我使用的语言列表https://github.com/highlightjs/highlight.js/blob/master/SUPPORTED_LANGUAGES.md

一些外壳样品：

Shell:      console, shell
Bash:       bash, sh, zsh
PowerShell: powershell, ps
DOS:        dos, bat, cmd

示例：

```bat
cd \
copy a b
ping 192.168.0.1
```

Answer 4

如果我只需要突出显示第一个单词作为命令，我经常使用

properties

:

```properties
npm run build
```  

我得到类似的东西：

npm运行构建

Answer 5

根据 GitHub 的文档有关 GFM 语法突出显示的代码块

我们使用 Linguist 来执行语言检测和语法突出显示。您可以在语言 YAML 文件中找到哪些关键字有效。

在 GitHub 上渲染，

console

使控制台后面的线条变为蓝色。

bash

、

sh

或

shell

似乎没有太多“突出显示”...您可以将

posh

用于 PowerShell 或 CMD。

Answer 6

使用knitr包：

```{r, engine='bash', code_block_name} ...

例如：

```{r, engine='bash', count_lines}
wc -l en_US.twitter.txt
```

您还可以使用：

• engine='sh'

  用于外壳

• engine='python'

  用于 Python

• engine='perl'

  、

  engine='haskell'

  以及许多其他类 C 语言，甚至

  gawk

  、AWK 等

Answer 7

Bitbucket 使用 CodeMirror 进行语法突出显示。对于 Bash 或 shell，您可以使用

sh

、

bash

或

zsh

。更多信息可以在配置文件扩展名的语法突出显示和代码镜像语言模式。

Answer 8

在黑曜石中，您可以使用

sh-session

https://prismjs.com/

Answer 9

```shell
your command line
```

或

```bash
your command line
```