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