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

Question

5

我为我的git页面编写了readme.md文件。现在我想在一些论坛上宣传我的程序。我不想每次都更新每个论坛的帖子，所以我想我只需链接到我的git repo，他们可以通过阅读readme文件获取有关我的工具的信息（将来，我只需要更新这个单一的文件）。

然而，源文件放在顶部，99%的访问者对代码一无所知。因此，如果他们只看到readme.md而不是代码（可能会吓跑他们“哦，我不懂它，看起来太难了，快速概述离开”），那么更容易吸引人。

是否有一种方法可以交换代码部分和readme.md部分？

- codepleb

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- VonC · Accepted Answer

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

目前在传统的GitHub存储库中还没有这种方法。

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

这将使代码部分非常简短，而下面的README将更加可见。

另一个存储库，由评论者 OP TrudleR提到，可以使用GitHub页面，就像使用gh-pages分支的项目站点。

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

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

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