跳至主要内容

关于维基

您可以在 Wiki 中托管存储库的文档,以便其他人可以使用和贡献您的项目。

谁可以使用此功能?

Wiki 在使用 GitHub Free 和 GitHub Free for organizations 的公共存储库中可用,以及在使用 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有存储库中可用。有关更多信息,请参阅“GitHub 的计划”。

GitHub.com 上的每个存储库都配备了一个用于托管文档的部分,称为 Wiki。您可以使用存储库的 Wiki 来共享有关项目的长篇内容,例如如何使用它、如何设计它或其核心原则。README 文件可以快速说明您的项目可以做什么,而您可以使用 Wiki 提供其他文档。有关更多信息,请参阅“关于 README”。

使用维基,您可以像在 GitHub 上其他地方一样编写内容。有关更多信息,请参阅“GitHub 上的写作和格式入门”。我们使用 开源 Markup 库 将不同格式转换为 HTML,因此您可以选择使用 Markdown 或任何其他支持的格式进行编写。

您可以使用 Markdown 将渲染的数学表达式、图表、地图和 3D 模型添加到您的维基。有关创建渲染的数学表达式的更多信息,请参阅“编写数学表达式”。有关创建图表、地图和 3D 模型的更多信息,请参阅“创建图表”。

如果您在公共仓库中创建维基,则该维基对公众可用。如果您在私有仓库中创建维基,则只有有权访问该仓库的人才能访问该维基。有关更多信息,请参阅“设置仓库可见性”。

您可以直接在 GitHub 上编辑维基,也可以在本地编辑维基文件。默认情况下,只有对您的仓库具有写入权限的人员才能更改维基,尽管您可以允许 GitHub.com 上的每个人对公共仓库中的维基进行贡献。有关更多信息,请参阅“更改维基的访问权限”。

注意:搜索引擎只会索引您配置为防止公众编辑的拥有 500 个或更多星标的维基。有关更多信息,请参阅“更改维基的访问权限”。

如果您需要搜索引擎索引您的内容,您可以在公共仓库中使用 GitHub Pages

注意:出于性能原因,维基对页面数量有 5,000 页的软限制。如果您超过此限制,某些页面可能无法供用户访问。

进一步阅读