Skip to main content

关于 wikis

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

Wiki 适用于具有 GitHub Free 和组织的 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。 有关详细信息,请参阅“GitHub 的产品”。

GitHub.com 上的每个仓库都配备了一个托管文档部分,叫做 wiki。 您可以使用仓库的 wiki 共享项目的长内容,例如如何使用项目,您是如何设计项目的,或者其核心原则是什么。 自述文件快速介绍项目的内容,而您可以使用 wiki 提供其他文档。 有关详细信息,请参阅“关于 README”。

使用 wiki,可以像在 GitHub 的任何其他位置一样编写内容。 有关详细信息,请参阅“在 GitHub 上编写和设置格式入门”。 我们使用开源标记库将不同的格式转换为 HTML,以便选择使用 Markdown 或任何其他支持的格式编写。

可使用 Markdown 将呈现的数学表达式、关系图、地图和 3D 模型添加到 Wiki。 有关创建呈现的数学表达式的详细信息,请参阅“编写数学表达式”。 有关创建关系图、地图和 3D 模型的详细信息,请参阅“创建关系图”。

如果在公共存储库中创建 wiki,则该 wiki 可供公共访问。 如果您在私有 存储库中创建 Wiki,则仅有权访问该仓库的人员 才能访问该 Wiki。 有关详细信息,请参阅设置存储库可见性

您可以直接在 GitHub 上编辑 wikis,也可在本地编辑 wiki 文件。 默认情况下,只有能够写入仓库的人才可更改 wikis,但您可以允许 GitHub.com 上的每个人参与公共仓库中的 wiki。 有关详细信息,请参阅“更改对 wiki 的访问权限”。

注意:搜索引擎不会对 Wiki 的内容编制索引。 若要通过搜索引擎对内容编制索引,可以在公共存储库中使用 GitHub Pages

延伸阅读