反应文档 - >使用特殊表语法的GitHub markdown文件

时间:2017-03-15 15:28:09

标签: reactjs github markdown github-flavored-markdown

如果您查看React docs markdown file(用于生成docs html pages),您会在最顶层看到值(在.md,而不是.html)。如果您查看用于创建表格的实际降价语法,您会看到非标准表格语法

---
id: hello-world
title: Hello World
permalink: docs/hello-world.html
prev: installation.html
next: introducing-jsx.html
redirect_from:
  - "docs/index.html"
  - "docs/getting-started.html"
  - "docs/getting-started-ko-KR.html"
  - "docs/getting-started-zh-CN.html"
---

我能找到的所有GitHub / markdown资源都表明这些表是这样创建的:

  

来自https://guides.github.com/features/mastering-markdown/

     

     

您可以通过汇总单词列表并将其分开来创建表格   连字符-(第一行),然后分隔每列   使用管道|

First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column

我已经用尽了我的谷歌搜索技巧,并想知道是否有人知道这是否是一个记录的功能,以及该文档可能在哪里?

1 个答案:

答案 0 :(得分:6)

那个YAML front matter,许多静态网站生成器*允许将其作为向文档添加元数据的手段。它实际上并不是Markdown本身的一部分--GitHub只是为它提供了漂亮的样式,因为它是如此常用。

正如Waylan评论的那样,值得注意的是,在Markdown实际被解析之前,静态网站生成器通常会剥离前端问题 - 因此它没有出现在React文档页面中。

*包括JekyllReact's docsGitHub Pages使用