如何将readme.md放在页面顶部

Question

我为我的git页面写了一个readme.md文件。现在我想在一些论坛上为我的节目做广告。我不想总是更新每个论坛条目，所以我只是链接到我的git repo，他们只需阅读自述文件即可获得有关我的工具的信息（将来，我需要的只是更新这个单个文件）。

但是，源文件位于顶部，99％将访问我的repo的人将无法获得有关代码的线索。因此，如果他们只是看到readme.md而不是代码（这可能会吓跑他们“哦，我没有得到它，并且看起来很难得到快速概述离开”，它会吸引更多人）。

有没有办法用readme.md部分切换代码部分？

Answer 1

  

有没有办法用readme.md部分切换代码部分？

目前还没有经典的GitHub回购。

一种解决方法是将顶级元素的数量限制到最小，将所有这些文件夹移动到src/或project/子文件夹中。

这会使代码部分变得非常短，README（正好在下面）会更加明显。

commented提供OP TrudleR的GitHub pages不同的回购，与project site using the gh-pages branch一样。

对于这种方法，我喜欢declare that branch as a submodule in the master branch of the same project repo：这样，我可以更新我的项目页面，同时更新项目本身的来源。

2016年8月更新： Simpler GitHub Pages publishing 现在允许将您的网页文件保存在相同分支的子文件夹中（不再需要gh-pages） ：

这些页面现在可以位于同一分支的子文件夹中。