创建和突显代码块

隔离代码块

通过在代码块的前后输入三反引号 ```，可创建围栏代码块。我们建议在代码块的前后各留一个空白行，使原始格式更易辨读。

```
function test() {
  console.log("notice the blank line before this function?");
}
```

呈现的 GitHub Markdown 的屏幕截图，其中显示了三重反引号如何以原始格式呈现代码块。代码块以“function test() {.”开头。

Tip

要在列表中保留格式，请确保将非围栏代码块缩进八个空格。

要在围栏代码块中显示三重倒引号，请将其包在四个倒引号内。

````
```
Look! You can see my backticks.
```
````

呈现的 GitHub Markdown 的屏幕截图，其中显示了四重反引号如何导致代码块两侧的三重反引号保持可见。代码块显示“Look! You can see my backticks.”

如果经常编辑代码片段和表，则可能受益于在 GitHub 上启用对所有注释字段采用固定宽度字体。有关详细信息，请参阅“关于在 GitHub 上编写和设置格式”。

您可以添加可选的语言标识符，以在围栏代码块中启用语法突显。

语法突出显示功能会更改源代码的颜色和样式，使其更易于阅读。

例如，要语法突显 Ruby 代码：

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

这将使用语法突出显示功能显示代码块：

GitHub 上显示的三行 Ruby 代码的屏幕截图。代码元素以紫色、蓝色和红色类型显示，以方便扫描。

我们使用 Linguist 执行语言检测，并选择第三方语法以强调语法。你可以在语言 YAML 文件中找出哪些关键字有效。

你也可以使用代码块在 Markdown 中创建关系图。 GitHub 支持 Mermaid、GeoJSON、TopoJSON 和 ASCII STL 语法。有关详细信息，请参阅“创建关系图”。