基本语法
斜体和粗体
使用 *
, **
, ***
标记表示斜体、粗体、斜粗体。*
可换为 _
。
示例:
这是 *
斜体*
这是 **
粗体**
这是 ***
斜粗体***
分级标题
使用 ===
表示一级标题,使用 ---
表示二级标题 (至少重复三次 =
或 -
)。
示例:
1 | 这是一个一级标题 |
或者在行首加 #
号表示不同级别的标题(H1-H6)
1 | # 这是一个一级标题 |
换行
如果另起一行,只需在当前行尾加 2个空格
如果是要起一个新段落,只需空出 1行
即可
示例:
1 | 在当前行的结尾加 2 个空格 |
在当前行的结尾加 2 个空格
这行就会新起一行
链接
使用 [描述](链接地址)
增加文字链接,
使用 <http://链接网址>
增加网址链接。
示例:
1 | 这是去往[Github](<https://github.com/>)的地址 |
这是去往Github的地址
1 | <https://github.com/> |
图片
使用 
插入图像。
示例:
1 |  |
无序列表
使用 *
, +
, -
加空格表示无序列表,支持列表嵌套。
示例:
1 | - 无序列表 一 |
- 无序列表 一
- 无序列表 一.一
- 无序列表 一.二
- 无序列表 二
- 无序列表 二.一
- 无序列表 二.二
- 无序列表 三
有序列表
使用 数字和点加空格
表示有序列表,支持列表嵌套。
示例:
1 | 1. 有序列表 一 |
- 有序列表 一
- 有序列表 二
- 有序列表 二.一
- 有序列表 二.二
- 有序列表 二.三
- 有序列表 三
- 有序列表 四 // 不用担心数字大小会自动纠正
文字引用
使用 >
表示文字引用,支持引用嵌套。
示例:
1 | > Roses are red, |
Roses are red,
Violets are blue,
Sugar is sweet,
And so are you.
代码块
使用 反引号
标记一小段行内代码,
使用 4个空格缩进
表示代码块,
或使用 3个反引号
标记表示代码块。
示例:
1 | `git` |
git
1 | ```bash |
1 | $ ifconfig |
删除线
使用 ~~
标记表示删除线。
示例:
1 | ~~修复BUG~~ |
修复BUG
分割线
使用三个以上的 *
, -
, _
来建立一个分割线,也可以在符号中插入空格。
示例:
***
* * *
---
- - -
___
_ _ _
高阶语法
表格支持
表格对齐格式
- 居中:
:----:
- 居左:
:----
- 居右:
----:
示例:
1 | | 项目 | 价格 | 数量 | |
项目 | 价格 | 数量 |
---|---|---|
计算机 | 1600 | 5 |
手机 | 12 | 12 |
管线 | 1 | 234 |
任务列表
使用带有 [ ]
或 [x]
(未完成或已完成) 项的列表语法撰写一个任务列表,并且支持子列表嵌套。
示例:1
2
3
4- [x] 任务 1
- [ ] 任务 2
- [ ] 任务 2.1
- [ ] 任务 2.2
- 任务 1
- 任务 2
- 任务 2.1
- 任务 2.2
行内 HTML 元素
Markdown 兼容 HTML,只需直接添加标签即可使用 HTML 元素。
示例:
1 | <b color="red">粗体</b> |
粗体
1 | <font color="red" size="5">5号红色字</font> |
符号转义
如果你的描述中需要用到 markdown 的符号,比如 _
, #
, *
等,但又不想它被转义,这时候可以在这些符号前加反斜杠,如 \_
, \#
, \*
进行避免。
示例:
1 | \*\*这里不会变粗\*\* |
**这里不会变粗**
LaTex 公式
使用 $
标记表示行内公式,
使用 $$
标记表示整行公式。
示例:
1 | $ E=mc^2 $ |
$ E=mc^2 $
1 | $$ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $$ |
$$ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $$
参考资料: