编辑 Wiki 内容

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

谁可以使用此功能？

Wiki 可用于具有 GitHub Free 和 GitHub Free for organizations 的公共代码库，以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有代码库。有关更多信息，请参阅“GitHub 的计划”。

本文档内容

您可以使用页面支持的标准标记或使用 MediaWiki 语法在 Wiki 中创建链接。例如

  • 如果您的页面使用 Markdown 呈现，则链接语法为 [Link Text](full-URL-of-wiki-page)。
  • 使用 MediaWiki 语法，链接语法为 [[Link Text|nameofwikipage]]。

添加图像

Wiki 可以显示 PNG、JPEG 和 GIF 图像。

  1. 在 GitHub 上，导航到代码库的主页。

  2. 在您的代码库名称下，单击 Wiki.

    Screenshot of the menu in a repository. The "Wiki" option is outlined in dark orange.

  3. 使用 Wiki 侧边栏，导航到您要更改的页面，然后单击**编辑**。

  4. 在 Wiki 工具栏中，单击.

    Screenshot of the toolbar on the edit page of the wiki. The icon to add an image is outlined in dark orange.

  5. 在“插入图像”对话框中，键入图像 URL 和替代文本（搜索引擎和屏幕阅读器使用）。

  6. 单击**确定**。

链接到代码库中的图像

您可以通过复制浏览器中的 URL 并将其用作图像的路径来链接到 GitHub 上代码库中的图像。例如，使用 Markdown 将图像嵌入到您的 Wiki 中可能如下所示

[[https://github.com/USERNAME/REPOSITORY/blob/main/img/octocat.png|alt=octocat]]

添加数学表达式和图表

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

受支持的 MediaWiki 格式

无论您的 Wiki 页面使用哪种标记语言编写，某些 MediaWiki 语法始终可用。

  • 链接（除了 AsciiDoc）
  • 通过 --- 的水平线
  • 简写符号实体（例如 δ 或 €）

出于安全和性能原因，某些语法不受支持。

  • 转录
  • 定义列表
  • 缩进
  • 目录