Markdown 基本语法
Version: 1.0.1
Date: 2017-07-06
***
文档格式说明
在本文中遵循如下格式说明:
- [\space] 表示输入一个空格;
- [\n] 表示输入一个回车符;
1. 标题
Markdown中标题用#表示,一个#表示一级标题,两个#表示二级标题,以此类推,共有六级标题。标准用法是, #后面加一个空格,然后是标题内容。例如,
Markdown语句:
#[\space]一级标题
##[\space]二级标题
###[\space]三级标题
####[\space]四级标题
实际显示效果如下:
一级标题
二级标题
三级标题
四级标题
另一种表示标题的方法是在标题文字的下一行行首加=号,=号的个数没有限制,一般用3个即好,也可以用1个。注意,=号必须在下一行的行首,且=号前不能有空格。
这种方法仅适用于一级标题,其显示效果与用一个#号表示一级标题是一样的。
例如,Markdown语句:
一级标题[\n]
===[\n]]\n]
#[\space]一级标题[\n]
实际显示效果如下:
一级标题
一级标题
2. 列表
列表分为两种,有序列表 和 无序列表。
有序列表
有序列表即在列表的每一项前面有数字。有序列表的创建方法是,在列表项前加‘1. ‘, ’2. ' 这样数字。例如,
Markdown语句:
1. 有序列表1[\space][\space][n]
2. 有序列表2[\space][\space][n]
3. 有序列表3[\n][\n]
实际显示效果如下:
- 有序列表1
- 有序列表2
- 有序列表3
注意:
- 有序列表项只有才单独的一个段内才会起效,即有序列表不能在一个段落内,而必须是连续两个回车,然后再开始进行列表;
- 列表项与列表项之间必须用回车符换行;
- 最后一个列表项之后需要有连续两个回车符,然后再进行下一个段落;
无序列表
无序列表的每一个列表项前无数字序号。无序列表的创建方法是,在列表线前加上*或者-,例如,
Markdown语句:
* 无序列表项1[\space][\space][\n]
* 无序列表项2[\space][\space][\n]
* 无序列表项3[\n][\n]
实际显示效果如下:
- 无序列表1
- 无序列表2
- 无序列表3
3. 换行
换行分为两种,段落内换行和段落间换行。
段落内换行
当需要在一个段落内换行时,直接在需要换行的地方输入连续两个空格,即可换到下一行行首。例如,
Markdown语句:
这里是行1行尾。[\space][\space][\n]
这里是行2行首。[\n][\n]
实际显示效果如下:
这里是行1行尾。
这里是行2行首。
段落间换行
段落间换行指的是,换行并重起一个新的段落。段落间换行的方法是,在上一个段落的结尾连续输入两个回车符。例如,
Markdown语句:
这里是段落1末尾。[\n][\n]
这里是段落2段首。
实际显示效果如下:
这里是段落1末尾。
这里是段落2段首。
注:
从上面两个示例中可以看出,段落内换行与段落间换行的区别在于,段落内换行只是换到下一行行首,而段落间换行时会在段落与段落间插入一个空白行。
4. 代码段
对于程序员来说,经常需要在所写的文档中插入代码段。Markdown中插入代码段的方式是,在每一行开头输入连续4个空格。代码段内可以用Tab键缩进代码。例如:
Markdown语句:
[\space][\space][\space][\space]//这是一段C语言代码
[\space][\space][\space][\space]int main()[\n]
[\space][\space][\space][\space]{[\n]
[\space][\space][\space][\space][\tab]printf("hello world.\n");[\n][\n]
[\space][\space][\space][\space]return 0;[\n]
[\space][\space][\space][\space]}[\n]
实际显示效果如下:
//这是一段C语言代码
int main()
{
printf("hello world.\n");
return 0;
}
注:
代码段必须作为一个单独的段落,即必须是[\n][\n](段落间换行)之后再输入代码。
5. 引用
当需要在文档中插入一段引用时,在引用内容的每一行行首插入一个'>'即可。例如,
Markdown语句:
> 这里是引用内容,行1[\space][\space][\n]
> 这里是引用内容,行2[\n][\n]
实际显示效果如下:
这里是引用内容,行1
这里是引用内容,行2
6. 分割线
Markdown中使用连续3个*表示分割线,例如,
Markdown语句:
以下是分割线[space][space][\n]
***[\n][\n]
实际显示效果如下:
以下是分割线
***
7. 字符转义
有些字符在Markdown中具有特殊的含义,例如>表示引用,#表示标题,单个*表示无序列表,等等。当需要在文档中输入这些字符,而不是让其起特殊作用时,需要在实际字符前加一个\字符(反斜杆),即转义字符。
例如, 当输入\*时,实际显示的是个*,而不是起列表作用。
8. 字体控制
在文档中经常需要用到粗体、斜体 字体强调一些内容。
- 粗体
使字体变成粗体的方法是在字符的前后分别加上两个*号 - 斜体
使字体变成斜体的方法是在字符的前后分别加上一个*号
例如,Markdown语句:
这里是**粗体**
这里是*斜体*
实际显示效果如下:
这里是粗体
这里是斜体
***
History:
Version: V1.0.0
Date: 2017-07-02
- 创建文档初始版本
Version: V1.0.1
Date: 2017-07-06
- 将Markdown示例语句放入代码框中显示
- 文章标题用“在文字下方加=”的方式表示,区别章节标题
- 标题部分(章节1)增加用=号表示一级标题的描述
- 增加Markdown字体控制部分(章节8)