在 GitHub 上是否有一种方法可以创建针对特定文件夹的 readme 文件？

Question

Github可以解析并显示存储库根目录下的readme.txt或readme.md文件。

我想为特定文件夹创建类似的readme文件。有没有办法做到这一点？

我想到的一个丑陋的 hack 是将文件命名为 _readmeme.md，使其出现在文件夹中的第一个位置，并让用户轻松找到并单击它。 - 这行不通，_README 出现在 最后 而不是第一个位置。

- ripper234

Answer 1

GitHub已经具备了这个功能。只需将您的README文件放在子目录中，它就会像根目录中的一个一样显示。

例如，请查看此子目录下的README.md： http://github.com/larsbrinkhoff/lbForth/tree/master/targets

- Lars Brinkhoff

---

嘿，我试过了，但是在readme文件的名称中有一个拼写错误，所以对我来说没有起作用。谢谢！ - ripper234

如果有多个子目录中都有一个README文件，那该怎么办呢？如何指定哪个子目录的README应该出现在“根目录”中呢？ - Tfovid

@Tfovid，当您查看顶级目录时，只会显示根目录的README。当您查看该子目录时，只会显示子目录的README。 - Lars Brinkhoff

Answer 2

我刚刚尝试了一件有效的事情，就是在README文件上使用.md扩展名，因此README.md，Github足够聪明，可以使用Markdown显示它（比纯文本好得多）。

- rafaelbiten

---

尝试过这个方法，但是使用“.md”扩展名并没有显示。你还能用这个方法吗？ - Jay Killeen

我的也完全不工作。要么这个功能已经被移除了，要么它在私有仓库上不起作用或者其他原因。 - Jay Killeen

我可以确认它有效。只是它只能工作到两个级别而不是三个。使用".md"也更加方便。 - Jay Killeen