版权声明:本文章参考了《小书匠markdown 官方教程》。未经作者允许,严禁用于商业出版,否则追究法律责任。网络转载请注明出处,这是对原创者的起码的尊重!!!
1 基本语法
1.1 转义
右斜线\
表示转义,markdown中字符 [、 \、 *、`、$都需需要加上转义符号才能使用原字符。
1.2 标题
#
加空格表示一级标题
##
加空格表示二级标题
###
加空格表示三级标题
####
加空格表示四级标题
#####
加空格表示五级标题
######
加空格表示六级标题
注意:只有当#
位于一行开头,或引用文字中的一行开头的才会起作用。
1.3 加粗和斜体
两个*
或_
环绕表示加粗,如**加粗**
,显示效果:加粗。
一个*
或_
环绕表示斜体,如*斜体*
, 显示效果:斜体。
三个*
或_
环绕或混用*
和_
表示粗斜体,如***粗斜体***
,显示效果:斜体。
1.4 删除线和分行线
两个 ~
环绕表示删除线,如~~删除线~~
,显示效果:删除线
三个 * 或 +或 -表示一条横线,如----
,显示效果:
1.5 引用
- 用
>
表示引用。- 对一段话引用只需在开头使用一次。
- 引用中可以使用标题,粗体、斜体、粗斜体、
删除线、代码
、代码块
、公式、有序或无序列表。- 引用中可以使用链接、图片、跳转、表格,在支持注脚的版本中也可以使用注脚。
- 可以多层引用
名字 年龄 张三 10
1.6 无序列表
- *或+或-,分别加空格表示无序列表
- 每级缩进一个TAB
-
- 可以多层列表
-
- 可以嵌套列表
-
- 每级缩进一个TAB
1.7 有序列表
- 有序列表用序号.加空格表示,
- 一个TAB为一级缩进
- 有序列表每一级都会重新开始排序
- 有序列表显示的是实际的序号与输入的序号无关,
-
- 可以多层列表,
-
- 可以嵌套列表
注意:大部分情况下,1个TAB,一个空格或两个或三个空格都能正确缩进,但是有些编辑器却无法解析一个空格。所以推荐使用TAB。
1.8 链接与图片
- 链接有三种方式:
- 行内式:
[描述文字](链接地址 “悬停提示")
- 参考式:
[描述文字][id]
,在任何地方使用[id](链接地址 “悬停提示")
,可以省略id,省略id表示id为描述文字, - 直接链接:
<完整链接地址>
,如:https://www.baidu.com
- 行内式:
- 图片的语法和链接前两种语法一致,只是在开头需要加上一个英文的感叹号
!
,表示这是图片。如:![这是行内式连接](www.baidu.com "百度")
1.9 语法嵌套
所有可在行内使用的语法都可以在其他语法中套用,比如 加粗 可在标题中使用。
1.10 代码和代码块
- 句内代码用 ` 代码 `表示,例如:
int a=2
- 代码块的每一行用四个空格或一个tab开头
1.11 HTML标签
- 只要支持GFM的markdown都兼容html标签
2 扩展语法
markdown版本 | cmd | csdn | xiaoshujiang |
---|---|---|---|
任务列表 | 支持 | 支持 | 支持 |
数学公式 | 支持 | 支持 | 支持 |
代码块高亮 | 支持 | 支持 | 支持 |
代码块设置行号 | 不支持 | 不支持 | 支持 |
目录 | 支持 | 支持 | 支持 |
思维导图目录 | 不支持 | 不支持 | 支持 |
脚注 | 支持 | 支持 | 支持 |
缩进 | 支持 | 支持 | 支持 |
下划线 | 不支持 | 支持 | 支持 |
文字高亮 | 不支持 | 支持 | 支持 |
页内跳转 | 支持 | 不支持 | 不支持 |
锚点跳转 | 不支持 | 支持 | 支持 |
标签 | 支持 | 不支持 | 支持 |
字体、颜色、大小 | 不支持 | 支持 | 支持 |
视频 | 不支持 | 不支持 | 支持 |
音频 | 不支持 | 不支持 | 支持 |
附件 | 不支持 | 不支持 | 支持 |
段代码文字格式 | 不支持 | 不支持 | 支持 |
流程图 | 支持 | 支持 | 支持 |
序列图 | 支持 | 支持 | 支持 |
统计图 | 不支持 | 不支持 | 支持 |
mermaid 流程图 序列图 甘特图 | 支持 | 支持 | 支持 |
html | 支持 | 支持 | 支持 |
思维导图 | 不支持 | 不支持 | 支持 |
2.1 任务列表
任务列表,- [] 任务
表示未完成- [X] 任务
表示已完成, 任务列表也支持多级使用。
- 未完成
- 已完成
- 已完成
2.2 LaTeX数学公式
2.2.1 基本语法
-
$数学公式$
——表示行内数学公式,如$a^+b^2 $
,显示效果: $a+b2 $; -
$$数学公式$$
—— 表示整行数学公式,如$$a^2+b^2 =c^2$$
,显示效果: a 2 + b 2 = c 2 a^2+b^2 =c^2 a2+b2=c2 -
xiaoshujiang markdown支持另一种写法:
```mathjax!
数学公式1
数学公式1
数学公式1
```
2.2.2 公式对齐
\begin{align} ... \end{align}
,使用&表示对齐位置,\\表示换行,\tag{n}标签序号。
$$
\begin{align}
h(x) =& \frac{1}{\int_xt(x)\mathrm{d}x} \tag{1} \\
=& \frac{1}{\int_x\eta(x)\mathrm{d}x}g(x)\tag{2}
\end{align}
$$
显示如下:
\begin{eqnarray} ...\end{eqnarray}
,使用&表示对齐位置
$$
\begin{eqnarray}
a & = & b + c \\
& = & d + e + f + g + h + i + j + k + l\\
&& +\: m + n + o \\
& = & p + q + r + s
\end{eqnarray}
$$
显示如下:
2.2.3 矩阵
- 简单矩阵——
$$\begin{matrix}…\end{matrix}$$
来生成矩阵,其中… 表示的是LaTeX 的矩阵命令,矩阵命令中每一行以 \ \ 结束,矩阵的元素之间用&来分隔开。
$$
\begin{matrix}
1 & 2 & 3 \\
4 & 5 & 6 \\
7 & 8 & 9
\end{matrix} \tag{1}
$$
显示如:
(1) 1 2 3 4 5 6 7 8 9 \begin{matrix} 1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9 \end{matrix} \tag{1} 147258369(1)
- 带括号的Matrix——可以给矩阵加上括号,分为两种:使用
\left矩阵左括号 ... \right矩阵右括号
(其中花括号要进行转义)或者把公式命令中的matrix 改成pmatrix(圆括号)、bmatrix(方括号)、Bmatrix(花括号)、vmatrix(行列式)、Vmatrix(双竖线)
等。
$$
\left\{
\begin{matrix}
1 & 2 & 3 \\
4 & 5 & 6 \\
7 & 8 & 9
\end{matrix}
\right\} \tag{2}
$$
显示如下:
(2) { 1 2 3 4 5 6 7 8 9 } \left\{ \begin{matrix} 1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9 \end{matrix} \right\} \tag{2} ⎩⎨⎧147258369⎭⎬⎫(2)
$$
\begin{pmatrix}
1 & 2 & 3 \\
4 & 5 & 6 \\
7 & 8 & 9
\end{pmatrix} \tag{4}
$$
显示如下:
(4) ( 1 2 3 4 5 6 7 8 9 ) \begin{pmatrix} 1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9 \end{pmatrix} \tag{4} ⎝⎛147258369⎠⎞(4)
$$
\begin{bmatrix}
1 & 2 & 3 \\
4 & 5 & 6 \\
7 & 8 & 9
\end{bmatrix} \tag{5}
$$
显示如下:
(5) [ 1 2 3 4 5 6 7 8 9 ] \begin{bmatrix} 1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9 \end{bmatrix} \tag{5} ⎣⎡147258369⎦⎤(5)
$$
\begin{Bmatrix}
1 & 2 & 3 \\
4 & 5 & 6 \\
7 & 8 & 9
\end{Bmatrix} \tag{5}
$$
显示如下:
(5) { 1 2 3 4 5 6 7 8 9 } \begin{Bmatrix} 1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9 \end{Bmatrix} \tag{5} ⎩⎨⎧147258369⎭⎬⎫(5)
$$
\begin{vmatrix}
1 & 2 & 3 \\
4 & 5 & 6 \\
7 & 8 & 9
\end{vmatrix} \tag{5}
$$
显示如下:
(5) ∣ 1 2 3 4 5 6 7 8 9 ∣ \begin{vmatrix} 1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9 \end{vmatrix} \tag{5} ∣∣∣∣∣∣147258369∣∣∣∣∣∣(5)
$$
\begin{Vmatrix}
1 & 2 & 3 \\
4 & 5 & 6 \\
7 & 8 & 9
\end{Vmatrix} \tag{5}
$$
显示如下:
(5) ∥ 1 2 3 4 5 6 7 8 9 ∥ \begin{Vmatrix} 1 & 2 & 3 \\ 4 & 5 & 6 \\ 7 & 8 & 9 \end{Vmatrix} \tag{5} ∥∥∥∥∥