在markdown中突出显示bash / shell代码

时间:2013-11-30 18:11:57

标签: bash shell markdown github-flavored-markdown

如何在markdown文件中突出显示bash / shell命令?


例如要突出显示js我写道:

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

要突出显示HTML代码,请使用```html

我们如何突出显示bash / shell命令?

6 个答案:

答案 0 :(得分:225)

取决于降价渲染引擎和降价风格。没有标准。例如,如果您的意思是github风味的降价,shell应该可以正常工作。别名为shbashzsh。您可以找到可用语法词法分析器列表here

答案 1 :(得分:13)

使用 knitr 包:

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

e.g:

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

你也可以使用:

  • engine='sh' for shell
  • engine='python' for python
  • engine='perl'engine='haskell'以及其他一些类C语言甚至gawkawk等。

答案 2 :(得分:7)

根据documentation from GitHub关于GFM语法突出显示的代码块

  

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

在GitHub上呈现,console使控制台变蓝后的行。 bashshshell似乎没有“突出”太多......您可以将posh用于PowerShell或CMD。

答案 3 :(得分:6)

我在https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code

上找到了很好的描述
  

代码块是Markdown规范的一部分,但语法高亮不是

     

但是,许多渲染器(例如Github的渲染器和Markdown Here)都支持语法突出显示。支持哪种语言以及应如何书写这些语言名称将随渲染器的不同而不同。 Markdown Here支持突出显示多种语言(以及非真正的语言,例如diff和HTTP标头);要查看完整列表以及如何编写语言名称,请参见highlight.js演示页面。

尽管我找不到有关使用highlight.js的任何官方git hub文档,但我已经测试了许多语言,并且似乎可以正常工作

要查看我使用过https://highlightjs.readthedocs.io/en/latest/css-classes-reference.html#language-names-and-aliases的语言列表

一些外壳样本:

Shell:      console, shell
Bash:       bash, sh, zsh
Powershell: powershell, ps
Dos:        dos, bat, cmd

示例:

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

答案 4 :(得分:3)

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

```properties
npm run build
```  

我得到类似的东西

npm 运行构建

答案 5 :(得分:0)

Bitbucket使用CodeMirror突出显示语法。对于bash或shell,可以使用shbashzsh。可以在Configuring syntax highlighting for file extensionsCode mirror language modes上找到更多信息。