显示基于操作系统的GitHub存储库的README

Question

背景

当您登陆网站上的GitHub存储库页面时，它会自动呈现位于根目录上的README.md文件。

问题：

我想为iOS和Windows分别设置一个，并根据查看页面的操作系统显示相应的一个。这是你可以做的吗？

我目前的解决方案是只为一个超大文件提供iOS和Windows部分的可点击标记，以便用户可以点击并跳转到该部分 - 这不是虽然理想，因为这个文件会变得非常大（它被用作设置指南）。

Answer 1

我不相信可以根据观众的操作系统显示不同的自述文件，我相信这是一件好事。我经常不得不在一台设备上查找并在另一台设备上使用它。

说什么用户不需要从他们的iPhone上查找Windows说明？

  

我目前的解决方案是只为一个超大文件提供iOS和Windows部分的可点击标记，以便用户可以点击并跳转到该部分 - 这不是虽然理想，因为这个文件会变得非常大（它被用作设置指南）。

这听起来对我来说是一个很好的解决方案，但如果你有很多内容，那么你可能会变得笨拙。

为什么不使用GitHub's wiki feature来获取详细的文档？ Windows和iOS都可以拥有自己的页面或页面。您的自述文件仍然可以包含一些基本信息并链接到维基。

或者，您可以使用GitHub Pages中的内容使用a dedicated gh-pages branch or a docs/ directory in your master branch发布网站。