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

cod*_*leb 5 github

我为我的 git 页面写了一个 readme.md 文件。现在我想在一些论坛上为我的程序做广告。我不想总是更新每一个论坛条目,所以我虽然我只是链接到我的 git repo,他们人们可以通过阅读自述文件来获取有关我的工具的信息(将来,我只需要更新这个单个文件)。

但是,源文件放在顶部,99% 的访问我的存储库的人对代码一无所知。因此,如果他们只看到 readme.md 而不是代码,它会更吸引人们(这可能会吓跑他们“哦,我不明白它看起来很难快速离开”)。

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

Von*_*onC 3

有没有办法将代码部分与 readme.md 部分切换?

经典的 GitHub 存储库中目前还没有。

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

这将使代码部分非常短,并且README(就在下面)更加明显。

正如OP TrudleR评论的那样, GitHub Pages提供了一个不同的存储库,例如使用 gh-pages 分支的项目站点

对于这种方法,我喜欢将该分支声明为同一项目存储库的主分支中的子模块:这样,我可以在更新项目本身的源代码的同时更新我的​​项目页面。


2016 年 8 月更新:更简单的 GitHub Pages 发布现在允许将页面文件保存在同一分支的子文件夹中(不再gh-pages需要):

现在,您可以在存储库设置中选择源,GitHub Pages 将在那里查找您的内容。

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