GitHub 编辑 wiki 内容
您可以将图片和内容链接添加到您的 wiki,并使用某些受支持的 MediaWiki 格式。
Wiki 适用于具有 GitHub Free 和组织的 GitHub Free 的公共仓库,以及具有 GitHub Pro、GitHub Team、GitHub Enterprise Cloud 和 GitHub Enterprise Server 的公共和私有仓库。 更多信息请参阅“GitHub 的产品”。
添加链接
您可以使用页面支持的标准标记或使用 MediaWiki 语法在 wiki 中创建链接。 例如:
- 如果您的页面使用 Markdown 渲染,则链接语法为
[链接文本](wiki 页面的完整 URL)
。 - 使用 MediaWiki 语法,链接语法为
[[链接文本|wiki 页面的名称]]
。
添加图像
Wikis 可显示 PNG、JPEG 和 GIF 图片。
- 在 GitHub 上,导航到仓库的主页面。
- 在仓库名称下,单击 Wiki。
- 使用 wiki 边栏,导航至要更改的页面,然后单击 Edit(编辑)。
- 在 wiki 工具栏上,单击 Image(图像)。
- 在“Insert Image”(插入图像)对话框,输入 URL 和 alt 文本(由搜索引擎和屏幕阅读器使用)。
- 单击确定。
链接到仓库中的图片
您可以通过在浏览器中复制链接并将其用作图像路径,链接到 GitHub 上仓库中的图像。 例如,使用 Markdown 在 wiki 中嵌入图像可能如下所示:
[[https://github.com/username/repository/blob/master/img/octocat.png|alt=octocat]]
受支持的 MediaWiki 格式
无论您的 wiki 页面以哪种标记语言编写,始终可使用某些 MediaWiki 语法。
- 链接 (Asciidoc 除外)
- 水平规则通过
---
- 简明符号实体(例如
δ
或€
)
出于安全和性能原因,某些语法不受支持。
- 嵌入包含
- 定义列表
- 首行缩进
- 目录