【问题标题】:Where is GitHub Flavored Markdown (GFM) actually used in GitHub?GitHub 中实际使用的 GitHub Flavored Markdown (GFM) 在哪里?
【发布时间】:2013-08-03 21:43:09
【问题描述】:

这对我来说一直是个谜,由于某种原因 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)到底在哪里用到?

(技术说明:Markdown 此处使用 GFM 换行符,因此无需使用 MD 的两空格换行符。)

确实是这么说的,但我发现这个 md 使用 2 个空格 br 方式。

【问题讨论】:

  • 您可能需要更改问题的标题以反映其新内容。

标签: github markdown github-pages


【解决方案1】:

与其他答案相反,在通过 GitHub 网站输入文本的情况下使用 GFM,而不是在 README.md 和 GitHub Wiki 中。 p>

来自https://help.github.com/articles/github-flavored-markdown(已添加重点)

GitHub 使用我们称之为“GitHub Flavored Markdown”(GFM)的东西 消息问题cmets

这背后的原因是 README.md 和 Wiki 是 Git 存储库的一部分,因此可以克隆到站点之外,人们可以合理地期望(标准)Markdown 而不是 GFM。

有关 GitHub 原理的更多信息,请参阅 https://github.com/github/markup/issues/208#issuecomment-24927799

编辑:

语法高亮(Pygments)与 GFM 是分开的,因为 GFM 使用语法高亮,但是语法高亮的存在并不需要 GFM,因此 GitHub Pages 将使用标准 Markdown 换行符:它使用 Pygments,但不使用GFM。

【讨论】:

  • 谢谢。这就是我的想法和想要确认的。事实上,我曾计划制作一些类似github.com/substack/stream-handbook 的页面作为我自己的输出,但发现使用非 GFM 换行符很难编辑,所以。我最终开发了自己的内容管理系统。
【解决方案2】:

当您在存储库首页上显示 README.md 文件时使用它,for example。此外,当您添加 cmets 时,它是 GFM。

【讨论】:

  • 也用于Github Pages,可以用Jekyll解释,翻译成html。比直接写 html 更好,IMO。
  • github.com/kenokabe/heroku-buildpack-nodejs/blob/master/… 这是我的一些 README.md,我刚开始尝试 Hello/nWorld。我明白了,没有换行符。我错过了什么??
  • @CodieCodeMonkey 是的 def,甚至开始在网站外使用,这很好!
  • @KenOKABE,您需要两个换行符来换行。 Markdown 将假定它可以将连续行格式化为单个段落,除非这与其他 Markdown 规则冲突。例如,Hello World 在下一行跟========= 不会假定========== 是同一段落的一部分,它将使用标题规则。
  • 我知道@Codie CodeMonkey,我说的是 GFM 换行系统,而不是传统的 MD 系统。我最喜欢 GFM 的是它在行尾不需要 2 个空格获得换行符。我错过了什么??
【解决方案3】:

github风格的markdown用于:

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

最少在 cmets 上(提交、拉取请求等)

关于问题的说明:它似乎使用了有限版本的 GFM,而不是 wiki 页面或自述文件。

【讨论】:

  • 谢谢@xero,你知道为什么 GFM 特定的换行样式不适用于它们吗?
  • np。不,我不太确定。对于 cmets,我认为这与他们不允许在这里使用多行 cmets 的原因相同。在答案上下文中可以,但在评论上下文中不行。
猜你喜欢
  • 2012-08-10
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2021-05-16
  • 1970-01-01
  • 2013-03-19
相关资源
最近更新 更多