跳至主要内容

使用 Wiki 记录项目

您可以使用 Wiki 共享有关项目详细的、长篇的信息。

谁可以使用此功能?

Wiki 在使用 GitHub 免费版和 GitHub 免费版 for 组织的公共仓库中可用,以及在使用 GitHub 专业版、GitHub 团队版、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库中可用。有关更多信息,请参阅“GitHub 的套餐”。

关于 Wiki

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

添加或编辑 Wiki 页面

您可以直接在 GitHub 上或使用命令行在本地添加和编辑 Wiki 页面。

为 Wiki 创建页脚或侧边栏

您可以向 Wiki 添加自定义侧边栏或页脚,以便为读者提供更多上下文信息。

编辑 Wiki 内容

您可以将图像和链接添加到 Wiki 中的内容,并使用一些受支持的 MediaWiki 格式。

查看 Wiki 的更改历史记录

因为 Wiki 是 Git 仓库,所以您所做的每个更改都是一个提交,您可以查看该提交。

更改 Wiki 的访问权限

默认情况下,只有仓库协作者才能编辑公共仓库的 Wiki,但您可以允许 GitHub.com 上的任何拥有帐户的用户编辑您的 Wiki。

禁用 Wiki

您可以禁用仓库的 Wiki。