Markdown 是一种轻量级标记语言,允许人们使用易读易写的纯文本格式编写文档,并可以导出 HTML、Word、图像、PDF、Epub 等多种格式。在此总结 Markdown 基本语法。
标题
1 | # 这是一级标题 |
段落
段落没有特殊的格式,直接编写文字就好,段落的换行是使用两个以上空格加上回车,也可以在段落后面使用一个空行来表示重新开始一个段落。
1 | 这是一个段落 |
这是一个段落
这是另一个段落
字体
1 | *斜体* |
斜体
斜体
粗体
粗体
粗斜体
粗斜体
分隔线
在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。也可以在星号或是减号中间插入空格。
1 | *** |
删除线
1 | ~~这句话中间将会出现删除线~~ |
这句话中间将会出现删除线
下划线
Markdown 并无下划线的原生语法,因为会和链接的默认样式产生混淆。解决方法是使用行内 HTML。
1 | <u>下划线文本</u> |
下划线文本
脚注
1 | 这是一句话 [^脚注]。 |
列表
无序列表使用星号、加号或是减号作为列表标记,这些标记后面要添加一个空格,然后再填写内容。
1 | * 第一项 |
- 第一项
- 第二项
有序列表使用数字并加上 . 号来表示。
1 | 1. 第一项 |
- 第一项
- 第二项
- 第三项
列表嵌套只需在子列表中的选项前面添加四个空格即可。
1 | 1. 第一项: |
- 第一项:
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
- 第二项:
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素
任务列表
1 | - [x] 写代码 |
- 写代码
- 读论文
区块
Markdown 区块引用是在段落开头使用 > 符号 ,然后后面紧跟一个空格符号。
1 | > 区块引用 |
区块引用
区块是可以嵌套的,一个 > 符号是最外层,两个 > 符号是第一层嵌套,以此类推。
1 | > 最外层内容 |
最外层内容
第一层嵌套内容
第二层嵌套内容
第一层嵌套后续内容
最外层后续内容
区块中使用列表。
1 | > 区块中使用列表 |
区块中使用列表
第一项
第二项
列表中使用区块。
1 | * 第一项 |
第一项
区块
第二项
代码
如果是段落上的一个函数或片段的代码可以用反引号 ` 把它包起来。
1 | `printf()` 函数 |
printf()
函数
用 ``` 包裹一段代码,并指定一种语言(也可以不指定)。
1 | print('这是一条python输出语句') |
链接
1 | [百度](https://www.baidu.com/) |
高级链接通过变量来设置一个链接,变量赋值在文档末尾进行。
1 | 这个链接用 1 作为网址变量 [Google][1] |
图片
开头一个感叹号 ! 接着一个方括号,里面放上图片的替代文字。接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 ‘title’ 属性的文字。
1 | ![alt 属性文本](图片地址 "可选标题") |
图片也可以像链接一样使用变量。
1 | 这个图片用 1 作为变量 [图片][1]. |
Markdown 还没有办法指定图片的高度与宽度,如果需要的话,可以使用普通的 <img>
标签。
1 | <img src="图片地址" width="50%"> |
表格
Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。
1 | | 表头 | 表头 | |
表头 | 表头 |
---|---|
单元格 | 单元格 |
单元格 | 单元格 |
设置表格对齐方式:
- -: 设置内容和标题栏居右对齐。
- :- 设置内容和标题栏居左对齐。
- :-: 设置内容和标题栏居中对齐
1 | | 左对齐 | 右对齐 | 居中对齐 | |
左对齐 | 右对齐 | 居中对齐 |
---|---|---|
单元格 | 单元格 | 单元格 |
单元格 | 单元格 | 单元格 |
转义
Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符。
1 | **文本加粗** |
文本加粗
** 正常显示星号 **
Markdown 支持转义的符号。
1 | \ 反斜线 |
公式
当你需要在编辑器中插入数学公式时,可以使用两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式来实现。会根据需要加载 Mathjax 对数学公式进行渲染。
1 | $$ J_\alpha(x) = \sum_{m=0}^\infty \frac{(-1)^m}{m! \Gamma (m + \alpha + 1)} {\left({ \frac{x}{2} }\right)}^{2m + \alpha} \text {,公式示例} $$ |
$$ J_\alpha(x) = \sum_{m=0}^\infty \frac{(-1)^m}{m! \Gamma (m + \alpha + 1)} {\left({ \frac{x}{2} }\right)}^{2m + \alpha} \text {,公式示例} $$