Skip to main content

此版本的 GitHub Enterprise 已停止服务 2022-06-03. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

关于 wikis

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

Wiki 适用于具有 GitHub Free 和组织的 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。

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

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

如果您在公共仓库中创建 wiki,则该 wiki 可供具有 您的 GitHub Enterprise Server 实例 访问权限的任何人访问。 如果您在私有 或内部 存储库中创建 Wiki,则仅有权访问该仓库的人员 才能访问该 Wiki。 更多信息请参阅“设置仓库可见性”。

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

注意: 搜索引擎不会对维基的内容编制索引。 要通过搜索引擎对内容编制索引,您可以在公共仓库中使用 GitHub Pages

延伸阅读