GitHub Flavored Markdown (GFM) 实际上在 GitHub 中的哪些地方使用？

Question

这对我来说一直是个谜，出于某种原因Google也没有帮助我，所以让我问一下。编辑：好的，我理解GFM在GitHub中无处不在，为什么GFM样式的换行编辑不可用？它被关闭了吗？我知道原始MD规则。我想在这里确认的是GFM换行规则。谢谢。我非常喜欢GFM，特别是其直观的换行方式。https://help.github.com/articles/github-flavored-markdown但是，我从来没有能够使用这种换行模式发布自己的Markdown。例如，我将一些语法列表MD复制到我的GitHub上的一个wiki的新页面中。

https://github.com/kenokabe/kenokabe.github.io/wiki/MarkDownGFM

正如您可以确认的那样，MD源代码。

This is intended as a quick reference and showcase. 
For more complete info, see [John Gruber's original spec]

应用了一个新的换行符，但结果没有显示出新的一行。

我错过了什么？GitHub Flavored Markdown (GFM) 在 GitHub 中实际上是在哪里使用的？

(技术说明：Markdown Here 使用 GFM 换行符，因此不需要使用 MD 的两个空格的换行符。)

它确实是这样说的，但我发现这个 md 使用了两个空格的 br 格式。

- user1028880

---

你可能想要更改问题的标题以反映其新内容。 - Ellen Spertus

Answer 1

与其他答案相反，GFM仅用于通过GitHub网站输入文本的情况，而不用于README.md和GitHub Wikis。

从https://help.github.com/articles/github-flavored-markdown（已强调）中得知。

GitHub使用我们称之为“GitHub Flavored Markdown”（GFM）来处理消息、问题和评论。

其背后的原因是README.md和Wikis是Git存储库的一部分，因此可以在站点外进行克隆，在这种情况下，人们合理地期望（标准）Markdown而不是GFM。

有关GitHub背后的原因，请参见https://github.com/github/markup/issues/208#issuecomment-24927799 编辑：

语法高亮（Pygments）与GFM是分开的。虽然GFM使用语法高亮，但语法高亮的存在并不意味着GFM。这就是为什么GitHub Pages将使用标准Markdown换行符的原因：它使用Pygments，但不使用GFM。

- rnkn

---

谢谢。这正是我所想并希望确认的。事实上，我计划制作一些类似于https://github.com/substack/stream-handbook的输出页面，但发现使用非GFM换行符很难进行编辑，因此我最终开发了自己的内容管理系统。 - user1028880

Answer 2

这是在你的代码库首页上展示 README.md 文件时使用的，例如。此外，在添加注释时也可以使用 GFM。

- Codie CodeMonkey

---

它还用于Github Pages，可以使用Jekyll解释并转换为HTML。在我看来，比直接编写HTML要好得多。 - Houdini

这是我的README.md的一部分，我刚刚在开头尝试了Hello/nWorld。没有换行，我看不懂。我错过了什么吗？ - user1028880

@CodieCodeMonkey 是的，它甚至开始在网站之外使用了，感觉不错！ - Houdini

@KenOKABE，你需要两个换行符来分段。Markdown会假设它可以将连续的行格式化为单个段落，除非这与其他Markdown规则冲突。例如，Hello World在下一行后面跟着=========不会被认为是同一段落的一部分，而是使用标题规则。 - Codie CodeMonkey

对我来说显而易见的是GFM的换行规则；所以当发现它没有被应用时，我就简单地认为根本没有使用GFM。这就是为什么我误解了情况，标题才会变成那样。 - user1028880

Answer 3

Github风格的Markdown用于以下内容：

• 您的存储库自述文件
• 存储库中的任何.md文件
• 问题
• 维基和页面

并且在注释（提交、拉取请求等）中最少使用。

关于问题的说明：它似乎使用的是比维基页面或自述文件更受限制的GFM版本。

- xero

---

谢谢@xero，你有没有想法为什么GFM特定的换行样式没有应用到它们？ - user1028880

不，我也不是很确定。对于注释，我想他们不允许多行注释可能是出于相同的原因。在答案环境中使用是可以的，但在评论环境中就不行了。 - xero