GitHub中的文档选项

我正在为一个GitHub项目编写文档，不知道应该在哪里编写。似乎有三个选项：、GitHub Wiki或存储库中的一组标记文件（例如，在docs/目录下），类似于README.md。可以理解，我不想在多个地方编写相同的文档，所以我必须选择一个

---

那么，这两种选择之间的区别、利弊是什么呢？有没有使用它们的经验或想法，特别是在项目文档中？除了这三个选项之外，还有其他选项吗？

这是一个非常好的问题，我个人根据更改频率和贡献者数量来决定

作为一个例子：在我们的一个项目（C++库）中，我们偶尔创建一个带有DOXYGEN的HTML文档（例如，在更新主发布分支时）。这是准静态页面的完美匹配。此外，您还可以获得一个子域

http://.github.io//

，您可以在上面注册自己的域

另一个项目包含开发人员和用户文档（C++程序）。我个人更喜欢在.md文件中为开发人员提供一个主工作流程，以使其与主线开发保持一致。更改将首先由请求审查

但是对于用户文档，我们选择了内置的wiki，因为它很容易编辑和修改，甚至可以允许非团队成员进行修改