跳至主要内容

使用 Wiki 记录您的项目

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

谁可以使用此功能?

维基在使用 GitHub 免费版和 GitHub 免费版(适用于组织)的公共仓库中可用,在使用 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库中也可用。有关更多信息,请参阅“GitHub 的计划”。

关于 Wiki

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

添加或编辑维基页面

您可以在 GitHub 上直接添加和编辑维基页面,也可以使用命令行在本地进行操作。

为您的维基创建页脚或侧边栏

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

编辑 Wiki 内容

您可以在维基中的内容中添加图像和链接,并使用一些支持的 MediaWiki 格式。

查看维基的更改历史记录

由于维基是 Git 仓库,因此您所做的每一次更改都是一个提交,您可以查看这些提交。

更改维基的访问权限

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

禁用 Wiki

您可以禁用仓库的维基。