围栏代码块
您可以通过在代码块的前后放置三个反引号 ```
来创建围栏代码块。我们建议在代码块的前后放置一个空行,以便更轻松地阅读原始格式。
```
function test() {
console.log("notice the blank line before this function?");
}
```
提示
要在列表中保留格式,请确保将非围栏代码块缩进八个空格。
要在围栏代码块中显示三个反引号,请将它们包装在四个反引号内。
````
```
Look! You can see my backticks.
```
````
如果您经常编辑代码片段和表格,您可能会受益于在 GitHub 上所有评论字段中启用等宽字体。有关更多信息,请参阅“关于在 GitHub 上编写和格式化”。
语法高亮
您可以添加一个可选的语言标识符以在您的围栏代码块中启用语法高亮。
语法高亮会更改源代码的颜色和样式,使其更易于阅读。
例如,要语法高亮显示 Ruby 代码
```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```
这将显示带有语法高亮的代码块
我们使用 Linguist 执行语言检测并选择 第三方语法 进行语法高亮。您可以在 语言 YAML 文件 中找到哪些关键字有效。
创建图表
您还可以使用代码块在 Markdown 中创建图表。GitHub 支持 Mermaid、GeoJSON、TopoJSON 和 ASCII STL 语法。有关更多信息,请参阅“创建图表”。