# 关于 Wiki 页面

您可以将仓库文档托管在 wiki 中，以便其他人使用和参与您的项目。

GitHub 上的每个存储库都配备了一个托管文档部分，称作 wiki。 您可以使用仓库的 wiki 共享项目的长内容，例如如何使用项目，您是如何设计项目的，或者其核心原则是什么。 自述文件快速介绍项目的内容，而您可以使用 wiki 提供其他文档。 有关详细信息，请参阅“[关于仓库 README 文件](/zh/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)”。

使用 wiki，可以像在 GitHub 的任何其他位置一样编写内容。 有关详细信息，请参阅“[Getting started with writing and formatting on GitHub（GitHub 写作和格式设置入门）](/zh/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github)”。 我们使用[开源标记库](https://github.com/github/markup)将不同的格式转换为 HTML，以便选择使用 Markdown 或任何其他支持的格式编写。

可使用 Markdown 将呈现的数学表达式、关系图、地图和 3D 模型添加到 Wiki。 有关创建呈现的数学表达式的详细信息，请参阅 [编写数学表达式](/zh/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions)。 有关创建关系图、地图和 3D 模型的详细信息，请参阅 [创建关系图](/zh/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams)。

如果在公共存储库中创建 wiki，则该 wiki 可供公开访问。 如果在专用存储库中创建 Wiki，则仅有权访问该存储库的人员才能访问该 Wiki。 有关详细信息，请参阅“[设置存储库可见性](/zh/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)”。

你可以直接在 GitHub 上编辑 wiki，也可在本地编辑 wiki 文件。 默认情况下，仅具有存储库写权限的人员才可以更改 wiki，但可以允许 GitHub.com 上的所有人为公共存储库中的 wiki 做贡献。 有关详细信息，请参阅“[更改对 wiki 的访问权限](/zh/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)”。

> \[!NOTE]
> 搜索引擎仅会为拥有 500 个或更多标星且你配置为防止公开编辑的 Wiki 建立索引。 有关详细信息，请参阅“[更改对 wiki 的访问权限](/zh/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)”。
>
> 如果需要搜索引擎对你的内容编制索引，可以在公共存储库中使用 GitHub Pages。 有关详细信息，请参阅 [GitHub Pages](/zh/pages)。

> \[!NOTE]
> 出于性能原因，无论文件类型如何，wiki 都有 5,000 个文件的软限制。 如果超出此限制，则用户可能无法访问某些页面。 如果需要更大 Wiki，建议使用 GitHub Pages。 有关详细信息，请参阅 [GitHub Pages](/zh/pages)。

## 其他阅读材料

* [添加或编辑 wiki 页面](/zh/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages)
* [为 wiki 创建页脚或边栏](/zh/communities/documenting-your-project-with-wikis/creating-a-footer-or-sidebar-for-your-wiki)
* [编辑 wiki 内容](/zh/communities/documenting-your-project-with-wikis/editing-wiki-content)
* [查看 wiki 的更改历史记录](/zh/communities/documenting-your-project-with-wikis/viewing-a-wikis-history-of-changes)
* [搜索维基](/zh/search-github/searching-on-github/searching-wikis)