我可以在GitHub页面中使用Markdown文件吗?

时间:2013-02-27 23:24:36

标签: github markdown wiki github-pages

the GitHub wiki does not support directories以来,我想将我的md文件放入GitHub页面。然而,当我打开它们时,我发现它们根本没有被解释。 GitHub只给我原始文件。见http://greenlaw110.github.com/Rythm/en/index.md。有什么想法吗?

2 个答案:

答案 0 :(得分:20)

文档在这方面并不是特别清楚,但鉴于Markdown渲染是由Jekyll完成的,我相信你需要他们称之为"YAML front matter"来编译页面。因此,请尝试将其放在文件的顶部:

---
title: Document Center
---

这应该足以触发杰基尔。 (然后你可以get fancy并开始使用布局等。)

答案 1 :(得分:1)

获得原始 index.md 文件的另一个原因(根据经验发现)是,如果您碰巧也有一个类似名称的 index.html 文件。这会阻止 GH 页面。

删除 index.html 会产生(在网站上)一个新的 index.html,带有解析的降价。原来的 index.md 将无法再访问。