我正在编写GitHub项目的文档，并想知道我应该在哪里写它。似乎有三个选项：GitHub Pages，GitHub Wiki或存储库中的一组Markdown文件（例如，在docs /目录下），类似于README.md。可以理解的是，我不想将相同的文档写入多个地方，所以我必须选择一个。
那么选项之间的区别，优缺点是什么？有关使用它们的经验或想法，尤其是项目文档？除了三个还有其他选择吗？
答案 0 :(得分：2)
这是一个非常好的问题，我个人根据变更频率和贡献者数量来决定。
作为示例：在我们的一个项目（c ++库）中，我们偶尔使用 doxygen 创建HTML文档（例如，在更新主版本分支时）。这是准静态 gh-pages 的完美匹配。此外，您获得了http://<user>.github.io/<project>/的子域名，您可以在其上注册自己的域名。
另一个项目包含开发人员和用户文档（C ++程序）。我个人更喜欢为 .md文件中的开发人员提供主要工作流程，以使其与主线开发保持一致。变更将首先通过拉取请求进行审核。
但对于用户文档，我们选择内置 wiki ，因为它很容易编辑和修改 - 甚至可以允许非团队成员进行修改