我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们
文章版本: GitHub.com

使用 wiki 为项目写文档

可使用 wiki 分享有关项目的详细、长式信息。

Wikis 可用于具有 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。更多信息请参阅“GitHub 的产品。”

关于 wikis

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

添加或编辑 wiki 页面

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

为 wiki 创建页脚或边栏

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

编辑 wiki 内容

您可以将图片和内容链接添加到您的 wiki,并使用某些受支持的 MediaWiki 格式。

查看 wiki 的更改历史记录

由于 wiki 是 Git 仓库,因此您进行的每个更改均为可查看的提交。

更改对 wiki 的访问权限

默认情况下,只有仓库协作者才能编辑公共仓库的 wiki,但您可以允许任何拥有 GitHub 的人编辑您的 wiki。

禁用 wiki

可禁用仓库的 wiki。

问问别人

找不到要找的内容?

联系我们