GitHub上Markdown语法 - wnh5/myStudy GitHub Wiki
基础写作和语法格式
标题
Markdown中标题如果想定义一个标题,可以在前面加上#(或者用#将标题括起来)。1-6个#分别表示1-6级标题。有的编辑器需要在#和正文之间加一个空格(Atom),有的编译器不用(MarkdownPad),为了保持同一建议都加上空格。
# 标题一
#标题一#
## 标题二
显示结果:
标题一
标题一
标题二
文本样式
Markdown支持4中文本样式,分别是:加粗、斜体、删除线和加粗且斜体。
样式 | 关键字 | 快捷键 | 样例 | 输出 |
---|---|---|---|---|
加粗 | ** **或者__ __ | command/control+b | 加粗文本 | 加粗文本 |
斜体 | * *或者_ _ | command/control+i | 斜体文本 | 斜体文本 |
删除线 | ~~ ~~ | 无 | 删除线 | |
加粗且斜体 | ** **和_ _ | 无 | 这个是:加粗且斜体 | **_这个是_加粗且斜体 |
引用文本
引用文本的关键字是>。
下面是一个引用:
>大家好!我是一个引用。
输出结果:
下面是一个引用:
大家好!我是一个引用
引用代码
引用代码有两种形式,一种是在文本中引入一个代码:使用一个倒引号括起来;另一种是插入一段代码:使用三个倒引号```括起来(非标准Markdown语法,Atom中支持MarkdownPad中不支持)。 我需要在文中插入快捷键
ctrl+v`.
结果:
我需要在文中插入快捷键ctrl+v
.
我需要引用一段代码:
``` c++ #三个倒引号后面加入引用代码的语言类型。编辑器会对应的进行渲染
int a = 1;
int b = 2;
int c = a+b;
```
结果:
我需要引用一段代码:
int a = 1;
int b = 2;
int c = a+b;
上面可以直接在三个倒引号后面加入引用代码的语言类型。编辑器会对应的进行渲染。当然我们也可以直接使用一个tab或四个空格来表示我要插入一段代码(Atom中是2个tab)。
链接
下面是行内链接示例:
[链接到百度](https://www.baidu.com "百度")
结果: 链接到百度
下面是一个参考链接的示例:
[链接到百度][1]
[链接到Google][2]
[还是链接到百度][1]
[1]:https://www.baidu.com
[2]:https://www.google.com
结果:
列表
我们可以使用*,+,-或者数字作为列表的关键字。同时列表也支持嵌套的形式。
- 主列表1
- 主列表2
1. 次列表1
2. 次列表2
+ 主列表3
结果:
- 主列表1
- 主列表2
- 次列表1
- 次列表2
- 主列表3
任务列表
任务列表是Git对标准Markdown语法的扩展,并不是标准Markdown语法。因此MarkdownPad不会对该语法进行渲染。但是使用Atom就会对该语法进行渲染。
- [x] 任务列表1
- [ ] 任务列表2
- [ ] 任务列表3
结果:
- 任务列表1
- 任务列表2
- 任务列表3
使用表情
Git中的Markdown语法扩展中包括了一些表情包。这个表情包语法依然可以通过Atom进行渲染。由于不是标准的Markdown语法不能通过MarkdownPad渲染。
表情一::+1:,表情二::o:
结果: 表情一::+1:,表情二::o:
忽略Markdown关键字
和C语言printf函数一样,如果我们不想让某个字符转换成Markdown关键字,可以在前面加上\ .比如我们想输入两个*,就可以用:
\*\*取消Markdown关键字
输出结果: **取消Markdown关键字
# 表格
表格同样不是标准的Markdown语法,使用MarkdownPad不会对该格式进行渲染。 形式一:
|表头一|表头二|
|------|---| #第二行中的-只要有三个或三个以上即可
|内容一|内容二|
|内容三|内容四|
结果:
表头一 | 表头二 |
---|---|
内容一 | 内容二 |
内容三 | 内容四 |
带左中右对其的表格:
|左对齐|居中对齐|右对齐|
|:- |:------:|-:| #第二列中的空格数没有要求,但至少要有一个
|左对齐列|居中对齐列|右对齐列|
|1|2|3|
结果:
左对齐 | 居中对齐 | 右对齐 |
---|---|---|
左对齐列 | 居中对齐列 | 右对齐列 |
1 | 2 | 3 |
插入图像
 #引号内的内容为鼠标悬停的时候显示的内容,和链接一样可以不用。中括号[]中的内容为找不到图片时的替代文字。
结果: