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 对总文件数有 5000 个文件的软限制，无论文件类型如何。如果超过此限制，某些页面可能无法访问。如果您需要更大的 Wiki，我们建议您使用 GitHub Pages。有关更多信息，请参阅“GitHub Pages”。