大多数输入 GitHub 的文本都可以利用标记语法来格式化文本。标记文本比同等的 HTML 更容易阅读和编写,但是可以在 GitHub 网站中显示为格式良好的 HTML。
任何输入到标记窗口的文本都被视为一个段落。每一个空行开始一个新的段落。只需输入即可写出全部内容,GitHub 内的 Markdown 引擎会在显示 HTML 结果时决定在哪里添加
段落标签。
您可以使用#字符在文本中创建标题。#之间的所有文本将成为一个 HTML
#这是 H1 文字#
###这是 H3 文字###
任何被星号字符()包围的文本都将以斜体显示。*任何被两个连续星号()包围的文本都将以粗体显示。**如果需要嵌套粗体和斜体,可以使用下划线(_)。例如:
*这应该是粗体,内有斜体 *
在 GitHub 中查看时,这将显示如下:
这个要加粗用 斜体 里面。
如果要添加报价,可以在报价前放置一个>符号。例如:
亚伯拉罕·林肯曾经说过
不要相信你在网上读到的一切
当在 GitHub 中显示时,这将如下所示:
亚伯拉罕·林肯曾经说过
ǀ不相信你在网上看到的一切
顺便提个好建议!
列表可以通过在项目前放置破折号(-)或星号(*)来创建。例如:
*主分支
*一月冲刺
*发布分支
将在 GitHub 中显示如下:
- 主分支
- 一月冲刺
- 释放分支
您可以使用数字而不是破折号或星号来创建有序列表。列表也可以嵌套,有序列表和无序列表可以组合。
倒勾字符(`)会将倒勾之间的文本显示为代码,例如:
按回车键
如果你在一段文本周围加上三个倒勾,整个部分将显示为代码。例如:
if(x = = 1){ 0
Console.write("预期的多行");
}
当在 GitHub 中显示时,这看起来像一个代码块:
if (x==1) {
Console.write("EXPECTED MULTIPLE ROWS")
}
这使得代码从文本的其余部分中脱颖而出。
链接(URL)和图像(引用图像文件的 URL)可以通过将链接文本放在括号[ ]中,将引用 URL 放在括号( )中来嵌入。例如,要引用 GitHub,您可以使用以下文本。
【访问我的 GitHub 页面】( https://www.github.com/KeeperSparky
)
这将在 GitHub 显示中产生以下链接:
访问我的 GitHub 页面
单击此链接时,用户将导航到指示的页面。
Markdown 已经存在 10 多年了,如果你想了解更多,可以访问这个链接。
除了标准的 Markdown 结构之外,GitHub 还对 GitHub 环境进行了额外的增强。
GitHub 中的下划线字符不用于组合粗体和斜体文本,因为下划线经常在代码中使用。GitHub 将忽略单词之间的下划线字符,并将它们视为文本的一部分。
如果 GitHub 检测到一个 URL 模式,比如 http://github.com,它会自动将其视为超链接。您仍然可以使用 Markdown 语法命名超链接,但是如果您想要显示一个 URL,直接键入 URL 并让 GitHub 显示它要容易得多。
由于添加和删除是 GitHub 代码显示的一大部分,您可以使用波浪号字符(~~)来指示删除线文本。例如:
~~删除了货币符号~ ~
该语法在 GitHub 中显示如下:
移除货币符号
您可以使用三回勾语法来显示代码部分,但是 GitHub 增加了一个额外的转折。通过在第一个倒勾标题后指定一个语言名称,GitHub 将对关键词进行颜色编码,并提供其他语法高亮功能。通过添加 JavaScript 作为语言,GitHub 将这段代码呈现为:
` `` JavaScript
if(x = = 1){ 0
Console.write("预期的多行");
}
在 GitHub 中:
if (x==1) {
Console.write("EXPECTED MULTIPLE ROWS")
}
这有助于开发人员,因为代码看起来可能与他们的开发工具相似。
GitHub 还允许使用#链接到现有的问题号,使用@指定用户名。
Markdown 和 GitHub 增强功能的结合提供了一个丰富的环境,可以在问题、提交消息、Wiki 文本等中生成风格优美的文本。一旦你熟悉了基本的语法,你会发现写这些文字是你的第二天性。