markdown文件的YAML标头在文档顶部生成奇数表

时间:2019-05-26 17:38:58

标签: github markdown github-flavored-markdown

我从我的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使用了一些有趣的markdown版本...?

1 个答案:

答案 0 :(得分:0)

  

也许问题是GitHub使用了一些有趣的markdown版本...?

YAML的前身不是Markdown itself的一部分。常规的Markdown处理器不会对其进行任何特殊处理。它可能会呈现<hr>和一些文本,也许以标题结尾。

但是可以,GitHub treats YAML front matter specially

  

许多博客网站(例如JekyllGitHub Pages)都取决于   文章开头的一些YAML格式的元数据。你知道,像这样在短划线之间出现的东西:

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

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