MarkDown语法

1. 标题

1
2
3
4
5
6
7
8
9
10
11
我是一级标题
=================
我是二级标题
-----------------

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

2. 段落格式

  • 段落换行:在段落末尾加两个空格再回车。
  • 或在两个段落中加入一个空行

3. 字体格式

1
2
3
4
5
6
7
8
9
10
11
12
13
14
  *斜体文本*
_斜体文本_

***
**粗体文本**
__粗体文本__

- - -
***粗斜体文本***
___粗斜体文本___

~~删除线~~
分割线 --- +++ ***
<u>下划线</u>

4. 注脚

1
2
文档中需要解释的句子,加入注脚[^比如这样]。
[^比如这样]: 可以在文档下面单独写注脚内容。

文档中需要解释的句子,加入注脚[^比如这样]。
[^比如这样]: 注脚内容:可以在文档下面单独写注脚内容。

5. 列表

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
* 第一项
* 第二项
* 第三项
+ 第一项
+ 第二项
+ 第三项
- 第一项
- 第二项
- 第三项

1. 第一项:
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
2. 第二项:
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素

6. 区块

1
2
3
4
5
6
> 区块快速编辑
> 区块第二行
> 区块第三行
> >嵌套区块
> > >还可以嵌套区块
> > >

区块快速编辑
区块第二行
区块第三行

嵌套区块

还可以嵌套区块

7. 代码块

将代码块使用````包裹起来
例如:

1
2
3
4
javascript
$(document).ready(function () {
alert('RUNOOB');
});

支持的 HTML 元素

不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 写。

目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>等 ,

例如:使用 Ctrl+Alt+Del 重启电脑

8. 链接

1
2
3
4
5
6
7
8
9
10
11
我是链接 [链接文字](https://www.链接地址.com)
单独写链接 <https://www.链接地址.com>

还可以通过变量来设置一个链接,变量赋值在文档末尾:

这个链接用 6 作为网址变量 [双击666][6]
这个链接用 ABC 作为网址变量 [万维网][ABC]
然后在文档的结尾为变量赋值(网址)

[6]: http://www.wanto.top/
[ABC]: http://www.网址.com/

我是链接 链接文字
单独写链接 https://www.链接地址.com

还可以通过变量来设置一个链接,变量赋值在文档末尾:

这个链接用 6 作为网址变量 双击666
这个链接用 ABC 作为网址变量 万维网
然后在文档的结尾为变量赋值(网址)

9. 图片

1
2
3
4
5
6
7
8
9
10
11
12
13
14
![alt 图片替代文本](图片地址)
最后还可以用引号包住并加上选择性的 'title' 属性的文字
![alt 图片无法显示时,显示的文本信息](图片地址 "可选标题")

还可以像网址那样对图片网址使用变量:

这个链接用 6 作为网址变量 [还是666][6].
然后在文档的结尾为变量赋值(网址)

[6]: http://xxx.com/images/xxx.jpg

Markdown中没有办法指定图片的高度与宽度,需要的话,可以使用普通的 <img> 标签。

<img decoding="async" src="http://xxx.com/images/x.jpg" width="50%">

10. 表格

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|  表头   | 表头  |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |

设置表格的对齐方式:
-: 设置内容和标题栏居右对齐。
:- 设置内容和标题栏居左对齐。
:-: 设置内容和标题栏居中对齐。

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
控制单元格宽度,长度单位可以是X%, pt , px, cm等。
<span style="display:inline-block;width:[长度]">[单元格文本]</span>

表头 表头
单元格 单元格
单元格 单元格
左对齐 右对齐 居中对齐
单元格 单元格 单元格
单元格 单元格 单元格

11. 高级技巧

  • 转义
    Markdown 使用了很多特殊符号来表示特定的意义,如果需要显示特定的符号则需要使用转义字符,Markdown 使用反斜杠转义特殊字符:
    1
    \*\* 正常显示星号 \*\*
    ** 正常显示星号 **
    Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:
1
2
3
4
5
6
7
8
9
10
11
12
\   反斜线
` 反引号
* 星号
_ 下划线
{} 花括号
[] 方括号
() 小括号
# 井字号
+ 加号
- 减号
. 英文句点
! 感叹号
  • 公式
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    $...$ 或者 \(...\) 中的数学表达式将会在行内显示。
    $$...$$ 或者 \[...\] 或者 ```math 中的数学表达式将会在块内显示。

    $f(x) = sin(x) + 12$

    $\sum_{n=1}^{100} n$

    $$
    \begin{Bmatrix}
    a & b \\
    c & d
    \end{Bmatrix}
    $$


    $$
    \begin{CD}
    A @>a>> B \\
    @VbVV @AAcA \\
    C @= D
    \end{CD}
    $$

$$
\begin{Bmatrix}
a & b \
c & d
\end{Bmatrix}
$$

$$
\begin{CD}
A @>a>> B \
@VbVV @AAcA \
C @= D
\end{CD}
$$

  • 流程图和甘特图
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    ```mermaid
    %% 语法示例
    gantt
    dateFormat YYYY-MM-DD
    title 软件开发甘特图
    section 设计
    需求 :done, des1, 2014-01-06,2014-01-08
    原型 :active, des2, 2014-01-09, 3d
    UI设计 : des3, after des2, 5d
    未来任务 : des4, after des3, 5d
    section 开发
    学习准备理解需求 :crit, done, 2014-01-06,24h
    设计框架 :crit, done, after des2, 2d
    开发 :crit, active, 3d
    未来任务 :crit, 5d
    耍 :2d
    section 测试
    功能测试 :active, a1, after des3, 3d
    压力测试 :after a1 , 20h
    测试报告 : 48h
    ```
    %% 语法示例
            gantt
            dateFormat  YYYY-MM-DD
            title 软件开发甘特图
            section 设计
            需求                      :done,    des1, 2014-01-06,2014-01-08
            原型                      :active,  des2, 2014-01-09, 3d
            UI设计                     :         des3, after des2, 5d
        未来任务                     :         des4, after des3, 5d
            section 开发
            学习准备理解需求                      :crit, done, 2014-01-06,24h
            设计框架                             :crit, done, after des2, 2d
            开发                                 :crit, active, 3d
            未来任务                              :crit, 5d
            耍                                   :2d
            section 测试
            功能测试                              :active, a1, after des3, 3d
            压力测试                               :after a1  , 20h
            测试报告                               : 48h
    

MarkDown语法
http://anximin.github.io/2023/05/19/markdown_YuFa/
作者
Sylar
发布于
2023年5月19日
许可协议