编辑 wiki 内容

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

谁可以使用此功能？

Wiki 适用于具有 GitHub Free 和组织的 GitHub Free 的公共存储库，以及具有 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]]。

添加图像

Wikis 可显示 PNG、JPEG 和 GIF 图片。

  1. 在 GitHub 上，导航到存储库的主页面。

  2. 在存储库名称下，单击“ Wiki”。

    存储库中菜单的屏幕截图。 “Wiki”选项用深橙色框标出。

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

  4. 在 Wiki 工具栏中，单击“”。

    Wiki 编辑页面上工具栏的屏幕截图。 用于添加图像的图标用深橙色框标出。

  5. 在“Insert Image”（插入图像）对话框，输入 URL 和 alt 文本（由搜索引擎和屏幕阅读器使用）。

  6. 单击" 确定"。

链接到仓库中的图片

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

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

添加数学表达式和关系图

可使用 Markdown 将呈现的数学表达式、关系图、地图和 3D 模型添加到 Wiki。 有关创建呈现的数学表达式的详细信息，请参阅“编写数学表达式”。 有关创建关系图、地图和 3D 模型的详细信息，请参阅“创建关系图”。

受支持的 MediaWiki 格式

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

  • 链接（AsciiDoc 除外）
  • 借助于 --- 的水平规则
  • 简明符号实体（例如 δ 或者 €）

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