跳至主要内容

创建和突出显示代码块

使用围栏代码块共享代码示例并启用语法高亮。

代码块

您可以通过在代码块前后放置三个反引号 ``` 来创建代码块。我们建议在代码块前后放置空行,以使原始格式更容易阅读。

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

Screenshot of rendered GitHub Markdown showing how triple backticks render code blocks in raw formatting. The block begins with "function test() {."

提示: 为了在列表中保留格式,请确保将非代码块缩进八个空格。

要在代码块中显示三个反引号,请将它们包裹在四个反引号中。

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

Screenshot of rendered GitHub Markdown showing how quadruple backticks cause triple backticks surrounding a code block to remain visible. The block reads, "Look! You can see my backticks."

如果您经常编辑代码片段和表格,您可能需要在 GitHub 上的所有评论字段中启用等宽字体。有关更多信息,请参阅 "关于在 GitHub 上编写和格式化."

语法高亮

您可以在代码块中添加可选的语言标识符以启用语法高亮。

语法高亮会更改源代码的颜色和样式,使其更易于阅读。

例如,要对 Ruby 代码进行语法高亮

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

这将显示带有语法高亮的代码块

Screenshot of three lines of Ruby code as displayed on GitHub. Elements of the code display in purple, blue, and red type for scannability.

我们使用 Linguist 来执行语言检测并选择 第三方语法 用于语法高亮。您可以在 语言 YAML 文件 中找到哪些关键字有效。

创建图表

您还可以使用代码块在 Markdown 中创建图表。GitHub 支持 Mermaid、GeoJSON、TopoJSON 和 ASCII STL 语法。有关更多信息,请参阅 "创建图表."

进一步阅读