Skip to main content

创建和突显代码块

通过围栏代码块和启用语法突显来分享代码样本

围栏代码块

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

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

渲染的围栏代码块

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

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

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

使用倒引号块呈现的围栏代码

If you are frequently editing code snippets and tables, you may benefit from enabling a fixed-width font in all comment fields on GitHub Enterprise Cloud. For more information, see "Enabling fixed-width fonts in the editor."

语法突显

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

例如,要语法突显 Ruby 代码:

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

渲染的启用 Ruby 语法突显的代码块

我们使用 Linguist 来执行语言检测并选择第三方语法进行语法突显。 您可以在语言 YAML 文件中找出哪些关键词有效。

创建图表

您还可以使用代码块在 Markdown 中创建关系图。 GitHub 支持 Mermaid、geoJSON、topoJSON 和 ASCII STL 语法。 更多信息请参阅“创建示意图”。

延伸阅读