跳至主要内容

编辑维基内容

您可以在 wiki 中添加图片和链接,并使用一些受支持的 MediaWiki 格式。

谁可以使用此功能?

维基在使用 GitHub Free(以及面向组织的 GitHub Free)的公共仓库中可用,也在使用 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库中可用。欲了解更多信息,请参阅 GitHub 的计划

您可以使用以下任意一种格式在 wiki 中创建链接。例如

  • 如果您的页面使用 Markdown 渲染,链接语法是 [Link Text](full-URL-of-wiki-page)
  • 使用 MediaWiki 语法,链接语法是 [[Nameofwikipage|Link Text]]

添加图片

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 侧边栏,导航到您想修改的页面,然后点击 Edit

  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. 在 “Insert Image” 对话框中,输入图片 URL 和 alt 文本(搜索引擎和屏幕阅读器会使用它)。

  6. 点击 OK

链接到仓库中的图片

您可以通过在浏览器中复制 GitHub 仓库中图片的 URL 并将其作为图片路径来链接该图片。例如,使用 Markdown 在 wiki 中嵌入图片的写法可能如下所示

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

添加数学表达式和图表

您可以使用 Markdown 在 wiki 中添加渲染后的数学表达式、图表、地图和 3D 模型。有关创建渲染数学表达式的更多信息,请参阅 编写数学表达式。有关创建图表、地图和 3D 模型的更多信息,请参阅 创建图表

受支持的 MediaWiki 格式

无论您的 wiki 页面使用何种标记语言,总有一些 MediaWiki 语法可供使用。

  • 使用 --- 插入水平分割线
  • 简写符号实体(例如 δ€

出于安全性和性能原因,部分语法不受支持。

  • 嵌入
  • 定义列表
  • 缩进
  • 目录
© . This site is unofficial and not affiliated with GitHub, Inc.