GitHub 关于 wikis
您可以将仓库文档托管在 wiki 中,以便其他人使用和参与您的项目。
Wiki 适用于具有 GitHub Free 和组织的 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。 更多信息请参阅“GitHub 的产品”。
每个 GitHub 仓库都有一个托管文档的部分,称为 wiki。 您可以使用仓库的 wiki 共享项目的长内容,例如如何使用项目,您是如何设计项目的,或者其核心原则是什么。 自述文件快速介绍项目的内容,而您可以使用 wiki 提供其他文档。 更多信息请参阅“关于自述文件”。
使用 wiki,可以像在 GitHub 的任何其他位置一样编写内容。 更多信息请参阅“在 GitHub 上编写和设置格式”。我们使用开源标记库将不同的格式转换为 HTML,以便选择使用 Markdown 或任何其他支持的格式编写。
Wikis 可在公共仓库中公开,也可在私有仓库中限于对仓库具有访问权限的人访问。 更多信息请参阅“设置仓库可见性”。
您可以直接在 GitHub 上编辑 wikis,也可在本地编辑 wiki 文件。 默认情况下,只有能够写入仓库的人才可更改 wikis,但您可以允许 GitHub 上的每个人参与公共仓库中的 wiki。 更多信息请参阅“更改 wikis 的访问权限”。