【问题标题】:YAML header of markdown file generates odd table on top of documentMarkdown 文件的 YAML 标头在文档顶部生成奇数表
【发布时间】:2019-05-26 17:38:57
【问题描述】:

我从我的 YAML 标头中得到一个奇怪的输出,这是我不打算的。 相反,我当然希望得到带有标题、作者和目录的正常输出。

以下代码产生以下输出:

---
title: General Stuff
author: Me
output:
    html_document:
    toc: true # table of content true
    toc_depth: 3  # upto three depths of headings (specified by #, ## and ###)
    number_sections: true  ## if you want number sections at each table header
    theme: united
---

产生这个输出:

我从显示文件的 GitHub 获得此输出。也许问题在于 GitHub 使用了一些有趣的降价版本...?

【问题讨论】:

  • 这只是 GitHub 预览...如果您将它与 github-pages 或类似内容一起使用,它将按预期工作...
  • 这点很好,mb21。提比利,你在这里的目标是什么?您是否尝试托管 Pages 网站?在 GitHub 上渲染 GFM,例如在自述文件中?还有什么?
  • @Chris 我正在尝试编写简单的降价文档,以便在我的 github 存储库中或当其他人在他们的机器上自己呈现 .md 文件(通过我们的共享存储库)时读取文本。
  • 感谢您的澄清,@thebilly。在那种情况下,我认为我在下面提供的答案是正确的。 (如果您使用 Jekyll 生成 Pages 站点,则应该使用 YAML 前端,而不是直接显示。)

标签: github markdown github-flavored-markdown


【解决方案1】:

也许问题在于 GitHub 使用了一些有趣的降价版本...?

YAML frontmatter 不是 Markdown itself 的一部分。普通的 Markdown 处理器不会对它做任何特别的事情。它可能会呈现<hr> 和一些文本,可能以标题结尾。

但是是的,GitHub treats YAML front matter specially:

许多博客网站,例如 JekyllGitHub Pages,都依赖于 文章开头的一些 YAML 格式的元数据。你知道,破折号之间的内容是这样的:

---
title: Blogging Like a Boss
---

从 [2013 年 9 月 27 日] 开始,我们将在 GitHub 中将此元数据呈现为 水平表,便于阅读

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2013-02-18
    • 1970-01-01
    • 1970-01-01
    • 2016-03-24
    • 1970-01-01
    • 1970-01-01
    • 2017-09-10
    • 1970-01-01
    相关资源
    最近更新 更多