GitHub 上的每个仓库都配备了用于托管文档的 Wiki。您可以使用仓库的 Wiki 分享关于项目的长篇内容，例如如何使用、如何设计或其核心原则。README 文件简要说明项目的功能，而您可以使用 Wiki 提供额外的文档。欲了解更多信息，请参阅 关于仓库 README 文件。
使用 Wiki，您可以像在 GitHub 其他地方一样编写内容。欲了解更多，请参阅 GitHub 写作与格式入门。我们使用 我们的开源 Markup 库 将不同格式转换为 HTML，您可以选择使用 Markdown 或任何其他受支持的格式编写。
您可以使用 Markdown 在 Wiki 中添加渲染的数学表达式、图表、地图和 3D 模型。有关创建渲染数学表达式的更多信息，请参阅 编写数学表达式。有关创建图表、地图和 3D 模型的更多信息，请参阅 创建图表。
如果您在公开仓库中创建 Wiki，则该 Wiki 对公众可见。如果您在私有仓库中创建 Wiki，则只有拥有仓库访问权限的人才能访问该 Wiki。欲了解更多信息，请参阅 设置仓库可见性。
您可以直接在 GitHub 上编辑 Wiki，也可以在本地编辑 Wiki 文件。默认情况下，只有对仓库具有写入权限的人才能修改 Wiki，尽管您可以允许 GitHub.com 上的所有人对公开仓库的 Wiki 进行贡献。欲了解更多，请参阅 更改 Wiki 的访问权限。
注意
搜索引擎仅会索引拥有 500 星以上且已配置为禁止公众编辑的 Wiki。欲了解更多，请参阅 更改 Wiki 的访问权限。
如果您需要搜索引擎索引您的内容，可以在公开仓库中使用 GitHub Pages。欲了解更多，请参阅 GitHub Pages。
注意
出于性能原因，Wiki 对总文件数（无论文件类型）设有 5,000 个的软限制。如果超过此限制，部分页面可能对用户不可访问。如果需要更大的 Wiki，我们建议使用 GitHub Pages。欲了解更多，请参阅 GitHub Pages。