创建和突显代码块

2023-06-12 09:46| 来源: 网络整理| 查看: 265

隔离代码块

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

``` 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 语法。有关详细信息，请参阅“创建关系图”。

延伸阅读 GitHub 式 Markdown 规范 "基本撰写和格式语法"

【本文地址】

今日新闻