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