原文:How to Format Code in Markdown
在 Markdown 中,有两种格式化代码的方法。你可以使用内联代码,在一行的某些部分周围加上反斜线(`),或者你可以使用代码块,有些渲染器会对其应用语法高亮。
内联代码
你可以使用内联代码格式来强调你所写的一行中的一个小命令或一段语法。
例如,你可能希望提到 JavaScript 的 Array.protoype.map()
方法。通过使用内联代码格式化,可以清楚地看到这是一段代码。你也可以用它来说明一个终端命令,比如 yarn install
。
要使用内联代码格式化,只需将你希望格式化的代码用反斜线包起来。在一个标准的 QWERTY 键盘上,可以在 “1” 的左边和 Tab 键的上面找到它。关于键盘上反引号的位置的更多信息,本文下方有介绍。
例如,在 markdown 中写 `Array.prototype.map()` 会呈现为 Array.prototype.map()
。
代码块
要写更长或更详细的代码片段,通常最好把它们放在一个代码块内。代码块允许你使用多行,而 markdown 会在它的后台用代码类型的字体渲染。
为了达到这个目的,在你的代码块开始的时候,要有一行三个反引号。这向 markdown 表明你正在创建一个代码块。你将需要用另一行三个反引号来结束,比如:
```
var add2 = function(number) {
return number + 2;
}
```
将被 markdown 渲染为:
var add2 = function(number) {
return number + 2;
}
语法高亮
虽然 markdown 本身不支持,但许多 markdown 引擎,包括 GitHub 使用的引擎,都支持语法高亮。这意味着,只要告诉 markdown 你在代码块中使用什么语言,它就会像 IDE 那样添加颜色。
你可以把语言的名字和你开头的三个反引号放在同一行上。在上面的例子中,如果你不在第一行写 ```,而是写 ```js,那么 JavaScript 高亮就会被应用到这个代码块。
var add2 = function(number) {
return number + 2;
}
语法高亮不仅可以应用于 JavaScript。你可以使用 ```html:
<div class="row">
<div class="col-md-6 col-md-offset-3">
<h1>Hello World</h1>
</div>
</div>
```ruby:
"Hello World".split('').each do |letter|
puts letter
end
或者 ```python:
a, b = 0, 1
while b < 10:
print(b)
a, b = a, a + b
请记住,不是所有的 markdown 引擎都会应用语法高亮。
国际键盘上的反引号
在不同的键盘上,反引号的位置可能不同,如果你使用的不是 QWERTY 键盘,可能会很难找到它。这份有用的指南列出了一些寻找回车键的方法,我们将其收集在下面: