GitHub 风味 Markdown
GitHub.com 使用自己版本的 Markdown 语法,该语法提供了一组额外的有用功能,其中许多功能可以更轻松地使用 GitHub.com 上的内容。
注意,GitHub 风味 Markdown 的某些功能仅在 Issues 和拉取请求的说明和注释中提供。这些包括@提及以及对 SHA-1 哈希、Issues 和拉取请求的引用。任务列表也可以在 Gist 评论和 Gist Markdown 文件中使用。
语法高亮
以下是如何使用 GitHub 风味 Markdown 进行语法高亮的示例:
以下是没有语法高亮的 Python 代码示例:
任务列表
如果你在 Issue 的第一条评论中包含任务列表,你将在问题列表中获得一个方便的进度指示器。 它也适用于拉取请求!
表格
你可以通过组合单词列表并用连字符 -
分隔(第一行),然后用管道符 |
分隔每个列创建表格:
会变成:
SHA 引用
对提交的 SHA-1 哈希 的任何引用都将自动转换为 GitHub 上对应提交的链接。
仓库内引用 Issue
任何引用 Issue 或拉取请求的编号都将自动转换为链接。
用户名 @提及
输入 @
符,后跟用户名,将通知该用户来查看评论。这被称为“@提及”,因为你_提及_了某个人。你还可以在组织内@提及团队。
自动链接 URLs
任何 URL(如 http://www.github.com/
)都将自动转换为可点击的链接。
删除线
用两个波浪号包裹的任何单词(比如 ~~这个~~
)都会显示出删除线。
Emoji
GitHub 支持 emoji!
要查看我们支持的所有图片的列表,请查看 Emoji 速查表。
Last updated