找不到在github项目和用户页面上使用markdown的详细，具体的文档

Question

我正在将github页面添加到我的一些repos和我的用户页面中。对于许多网页，我想使用Markdown格式。

但是，由于我只能找到有关如何执行此操作的vague, undetailed信息，因此我正在进行反复试验以确定其工作原理。

真正的文档在哪里？血淋淋的细节？

---

Here是迄今为止我发现的最佳信息，其中说：

• 使用特殊分支名称gh-pages为项目仓库创建站点

• 文件顶部需要三行咒语：

  ---
  title: something
  ---
  

• 后缀更改为.html

但是我对细节有很多疑问，例如：

• 我可以导入css文件吗？
• 这个“标题”模糊实际上做了什么？
• 文件需要具有什么后缀？

等。所以我真的很想看到所有功能的详细文档。

---

请注意，这个问题不是关于如何使用Markdown语法，而是如何利用github的魔力在用户和项目页面范围内自动从Markdown创建html。

Answer 1

  

如何利用github的魔力在用户和项目页面范围内自动从Markdown创建html

听起来你在谈论Jekyll。

---

  

“标题”模糊实际上做了什么？

title是YAML Front Matter的一部分。它基本上是一个变量，您可以access通过page.title

---

  

文件需要什么后缀？

如果文件有YAML Front Matter部分，它将由Jekyll转换。对于您网站的根目录中的任何.html，.markdown，.md或.textile文件或上面未列出的目录，也会发生同样的情况。

github.com/mojombo/jekyll/wiki/usage

Answer 2

只有扩展名为.md或.markdown的文件才会在GitHub用户页面上翻译为HTML。

根据我的尝试，扩展名为.html和.textile的文件不已翻译。

请注意，应避免使用UTF8编码。