最近写GitHub上的README.md文件,要用到Markdown语法,所以本文总结一下用于写 .md
,.markdown
结尾的文档的基本语法。
网上有不少在线的Markdown编辑器,本人一般用GitHub直接编写然后在线预览,或者用UltraEdit编辑器实时预览。
目录
标题
可以用 =
标记一级标题、-
标记二级标题,或者用 #
标记各级标题(符号后有空格)。
1 | 一级标题 |
格式
换行
两个以上空格加上回车,或者在段落后面使用一个空行来表示重新开始一个段落。 具体可以看下下面的演示图。
字体
1 | *斜体文本* |
效果
斜体文本
斜体文本
粗体文本
粗体文本
粗斜体文本
粗斜体文本
分隔线
在一行中用三个以上的星号、减号、底线来建立一个分隔线
1 | *** |
删除线
在文字的两端加上两个波浪线 ~~
即可,部分编辑器单个波浪线也可。
1 | ~删除线~ |
下划线
1 | <u>下划线</u> |
列表
无序列表使用星号(*
)、加号(+
)或是减号(-
)作为列表标记,有序列表使用数字并加上 .
号来表示。注意符号后有空格,可嵌套使用。
1 | * 第一项 |
效果
- 第一项
- 第二项
- 第一项
- 第二项
- 第一项
- 第二项
- 第一项
- 第二项
- 第三项
嵌套
- 第一层
- 第二层
- 第三层
- 第二层
- 第一层
- 第二层
- 第三层
- 第二层
区块(引用)
区块引用是在段落开头使用 >
符号 ,然后后面紧跟一个 空格 。注意换行使用两空格和直接空行的区别。区块也可以嵌套使用,也可以和列表混合嵌套。
1 | > 区块引用 |
效果
区块引用
第一行后没用两空格的内容
第二行用了两空格用于换行上一行行空行效果
最外层
第一层嵌套
第二层嵌套
区块中使用列表
- 第一项
- 第二项
- 第一项
引用
内容- 第二项
代码
段落上的一个函数或片段的代码可以用反引号把它包起来(`
)。代码区块使用 **4 个空格** 或者一个 **制表符(Tab 键)** ,或者用 ```
包裹一段代码,并指定一种语言(也可以不指定)。
1 | `printf()` 函数 |
链接
1 | [链接名称](链接地址) |
效果
图片
1 | ![alt 属性文本](图片地址) |
效果
Markdown
不能定义图片大小,可以用<img>
标签来插入图片。
表格
使用 |
来分隔不同的单元格,使用 -
来分隔表头和其他行。
-:
设置内容和标题栏居右对齐。:-
设置内容和标题栏居左对齐。:-:
设置内容和标题栏居中对齐。
1 | | 表头 | 表头 | |
效果
表头 | 表头 |
---|---|
单元格 | 单元格 |
单元格 | 单元格 |
对齐方式:左对齐 | 对齐方式:右对齐 | 对齐方式:居中对齐 |
---|---|---|
单元格 | 单元格 | 单元格 |
单元格 | 单元格 | 单元格 |
兼容
Markdown
是支持 HTML
的,想要更好的显示效果可以使用 HTML
的写法来编辑文本。