如何在GitHub的Markdown中显示一段普通文本?

48
我很难在谷歌上找到这个(非常简单的?)问题的真正答案,我开始担心可能没有解决方案。 我正在学习GitHub标记语言。我想展示一些包含虚假电子邮件地址的示例代码,比如user@example.com。但是GitHub坚持自动链接该文本。我还有一大段包含许多特殊字符的文本。 是否有办法转义区块或部分,以便不处理任何特殊字符,并且不生成自动链接?
3个回答

96
`将该块用反引号括起来:`
```text
code();
address@domain.example
```

13
有时候这会触发语法高亮。你可以(可能需要检查)通过在代码围栏开头的三个反引号后面添加单词“text”来修复这个问题: ```text - Ajedi32
1
这在 Github 格式化的评论中可以工作,比如问题报告。有趣的是,这也适用于 Discord。您可以通过在第一个三个反引号的同一行上包含语言名称来指定语法突出显示。例如,```js 将阻止封装文本并突出显示 Javascript 语法。 - Magic Marbles
@danday74 当时,被接受的答案是唯一可用的答案。我不想从一个正确且先到的答案中撤回绿色勾选标记,但我给了这个答案一个赞。希望用户养成寻找页面上不止第一个答案的习惯。 - snapfractalpop
2
对于单行文本,您也可以使用单个反引号,例如address@domain.com - shaahiin

31

您可以使用

标签将此类文本包裹起来。

<pre>Text I want left alone@donotlinkme.example</pre>

我刚在Github上测试了一下。


6
我尝试过这个,但它实际上会干扰 Github 上的一些格式。使用 ```文本回答 更安全。 - danday74

8

这都是 Kramdown 语法的一部分,最后一个链接展示了 GitHub markdown 的所有技巧。

所以这也能起作用:

~~~text
code();
address@domain.example
~~~

这实际上是最有帮助的,如果你想展示如何使用Markdown本身。与反引号或XML/HTML像<pre>...</pre>不同,这似乎允许真正的逐字逐句文本。 - Georg Jung

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接