一、概述
Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,可以使普通文本内容具有一定的格式。Markdown的语法简介明了、学习容易,而且功能比纯文本更强,因此有很多人用它写博客。
二、使用指南
(需注意的是段前段后要空一行,并且与内容部分之间要加空格)
1、标题
在行首插入1到6个#,对应标题1到6阶,例如:
# 这是H1
## 这是H2
###### 这是H6
2、引用
Markdown引用使用类似email中用>的引用方式,在每行的最前面加上 > 即可,例如:
> 这是一段引用。
显示效果如下:
这是一段引用。
引用也可以嵌套使用,只需要根据层次加上不同数量的 > 即可。
> 这是第一段引用。
> > 这是第二段引用。
> > > 这是第三段引用。
显示效果如下:
这是第一段引用。
这是第二段引用。
这是第三段引用。
另外引用的区块内可以使用其他的Markdown语法,包括标题、列表、代码区块等,例如:
> ## 这是一个标题
>
> 1. 这是第一行列表项。
> 2. 这是第一行列表项。
>
> 下面是一行代码
>
> `print("Hello World!")`
显示效果如下:
这是一个标题
- 这是第一行列表项。
- 这是第一行列表项。
下面是一行代码
print("Hello World!")
3、列表
Markdown支持有序列表和无序列表。
无序列表使用* + -
作为列表标记,例如:
* 使用【星号、加号、减号】标识无序列表
* 使用【星号、加号、减号】标识无序列表
* 使用【星号、加号、减号】标识无序列表
显示效果如下:
- 使用【星号、加号、减号】标识无序列表
- 使用【星号、加号、减号】标识无序列表
- 使用【星号、加号、减号】标识无序列表
有序列表使用数字机上一个英文句号,例如:
1. 我有一个梦想
2. 我有两个梦想
3. 我有三个梦想
显示效果如下:
- 我有一个梦想
- 我有两个梦想
- 我有三个梦想
4、代码区块
要在Markdown中建立代码区块有两种。
- 第一种:简单文字出现一个代码框使用,例如:
print("Hello World!")
- 第二种:大段文字需要实现代码框,使用Tab键或者四个空格或者“`,例如:
for i in range(1,5):
for j in range(1,5):
for k in range(1,5):
if( i != k ) and (i != j) and (j != k):
print i,j,k
5、分割线
可以在一行中用3个以上的* - _
来建立一个分割线,行内不能有其他内容。但是可以在*
或-
中间加入空格,例如:
***
------
__________
显示效果如下:
6、链接
Markdown支持两种形式的链接语法,分别为内联样式和引用方式,但是不管是哪一种,链接文字都是用 [方括号] 来标记。
建立一个内联样式,只要在方括号后面紧接着(圆括号)并插入链接即可,如果想要加上链接的文字,只要在网址后面,用””双引号把文字包起来即可,例如:
This is [an example link] (http://www.mi-zhu.com "米筑官网")
显示效果如下:
This is [an example link] (http://www.mi-zhu.com “米筑官网”)
引用方式是在链接文字的方括号后面再接上另一个方括号,而在第二个方括号里面填入用以辨识链接的标记,例如:
常用的搜索引擎主要有[百度][1]、[谷歌][2]、[必应][3]等。
[1]: https://www.baidu.com "百度"
[2]: https://www.google.com "谷歌"
[3]: https://cn.bing.com "必应"
显示效果如下:
7、强调
Markdown使用星号(*
)或者底线(_
)作为标记强调字词的符号,被一个* _
包围的字词会变成斜体,被两个* _
包围的字词会变成粗体,被三个* _
包围的字词会变成粗斜体,例如:
*这是斜体*
**这是粗体**
***这是粗斜体***
显示效果如下:
这是斜体
这是粗体
这是粗斜体
8、图片
图片的处理方式和链接的处理方式,非常的类似,同样也允许两种样式:内联样式和引用方式。
内联样式的语法如下:
![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title")
- 一个感叹号!
- 接着一个方括号[],里面放上图片替代文字
- 接着一个圆括号(),里面放上图片的网址,最后还可以使用引号""加上选择性的文字
引用方式的语法如下:
![Alt text][id]
[id]: url/to/image "Optional title attribute"
- [id]是图片参考的名称,图片参考的定义方式与链接参考一样
- 不过到目前为止,Markdown语法还没有办法指定图片的宽高,如果需要的话,则需使用HYML语言中的<imag>标签
9、文字删除线
Markdown使用前后两个波浪线(~)作为字词删除线的符号,例如:
~~文字删除线~~
显示效果如下:
文字删除线
10、表格
Markdown作为一种轻量级书写/写作语言,并没有提供很好的排版、编辑功能。Markdown只提供了简单的创建表格与内容对齐的功能,例如:
| 一个普通标题 | 一个普通标题 | 一个普通标题 |
| ---- | ----: | :----: |
| 短文本 | 中等文本 | 稍微长一点的文本 |
| 稍微长一点的文本 | 短文本 | 中等文本 |
显示效果如下:
一个普通标题 | 一个普通标题 | 一个普通标题 |
---|---|---|
短文本 | 中等文本 | 稍微长一点的文本 |
稍微长一点的文本 | 短文本 | 中等文本 |
语法说明:
- 不管是哪种方式,第一行为表头,第二行分隔表头和主体部分,第三行开始每一行代表一个表格行。
- 列与列之间用管道符号 “|” 隔开,原生方式的表格每一行的两边也要有管道符。
- 可在第二行指定不同列单元格内容的对齐方式,默认为左对齐,在 “-” 右边加上 “:” 为右对齐,在 “-” 两侧同时加上 “:” 为居中对齐。
11、转义符(反斜杠)
Markdown 可以利用反斜杠来插入一些在语法中有其它意义的符号,比如,如果想要用星号加在文字旁边的方式来做出强调效果,可以在星号的前面加上反斜杠,例如:
\*加星号只是为了强调效果\*
显示效果如下:
*加星号只是为了强调效果*
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:
\ 反斜线
` 反引号
- 星号
_ 底线
{} 花括号
[] 方括号
() 括弧
# 井号- 加号
- 减号
. 英文句点
! 惊叹号