阅读(2673) (2)

GitHub 创建和突显代码块

2020-08-19 14:35:08 更新

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

围栏代码块

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

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

渲染的围栏代码块

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

语法突显

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

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

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

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

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

延伸阅读