Markdown语法

243 阅读5分钟

Markdown 语法

标题

标题能显示出文章的结构。行首插入1-6个 # ,每增加一个 # 表示更深入层次的内容,对应到标题的深度由 1-6 级。

语法:

一级标题 : # macbl

二级标题 : ## macbl

三级标题 : ### macbl

四级标题 : #### macbl

五级标题 : ##### macbl

六级标题 : ###### macbl

加粗

文字左右分别用两个 * 号。

语法:

**macbl**

斜体

文字左右分别用一个 * 号。

语法:

*macbl*

斜体加粗

文字左右分别用三个 * 号。

语法:

***macbl***

高亮

文字左右分别用两个 = 号.

语法:

==高亮文字== 

字体颜色

可以通过HTML语法来设置一些样式,如字体和颜色等
语法:
<span style="color: red">这里的字是红色的</span>

引用

在引用的文字前加 > 即可,引用可以嵌套,如加两个 >> 三个 >>>。

语法:

>macbl

>>macbl

>>>macbl

分割线

三个或者三个以上的 - 或者 * 都可以。

语法:

--- 或 ****

图片

语法:

![图片描述](图片地址)

图片描述就是显示在图片下面的文字,相当于对图片内容的解释。

例:

![Ulysses](https://static.skyandroid.cn/images/logo/2018011315158395926772.png?x-oss-process=style/h_300-w_300)

使用base64在Markdown文档中加载图片,无需使用图床以及网络加载图片
在正文中使用
![图片描述][下面设置的图片id] 
在文档底部添加base64资源
[图片id]:图片转base64结果
如 [图片id]:data:image;base64,图片编码

链接

语法:

[标题](链接地址)

例:

[macbl](https://www.macbl.com/)

邮箱等链接也能使用<>
例如:<http://www.baidu.com>

列表

1.无序列表

用 - + * 任何一种都可以。注意:- + * 跟内容之间都要有一个空格。

语法:

- 无序列表内容

+ 无序列表内容

* 无序列表内容

2.有序列表

用 数字加点 即可。注意:序号跟内容之间要有空格。

语法:

1. 有序列表内容

2. 有序列表内容

3. 有序列表内容

3.列表嵌套

上一级和下一级之间敲 三个空格 即可。

语法:

- 无序列表内容

   + 无序列表内容

   * 无序列表内容


1. 有序列表内容

   1. 有序列表内容

   2. 有序列表内容

公式

$行内公式$

$$
行间公式
$$

上标 ^,例如 $x^2$
下标 _或者~,例如$H_2O$
小括号和中括号 使用原始的( ) ,[ ] 即可,如$(2+3)[4+4]$    
使用\left(或\right)使符号大小与邻近的公式相适应(该语句适用于所有括号类型),如$\left(\frac{x}{y}\right)$
求和 \sum,下标表示求和下限,上标表示求和上限,例如 $\sum_{r=1}^n$,{}表示一个组整体
积分 \int,同样上下标表示积分上下线,例如 $\int_{r=1}^\infty$
二重积分 \iint,三重积分\iiit,依次类推。
根号 \sqrt,例如 $\sqrt {a+b}$  $\sqrt[4]{\frac xy}$
分号 \frac,例如 \frac ab   $\frac {a+c+1}{b+c+2}$
小于 (\lt ):\lt
大于 (\gt ):\gt
小于等于 (\le ):\le
大于等于 (\ge ):\ge
不等于 (\ne ) : \ne
可以在这些运算符前面加上\not ,如\not\lt : \not\lt`
矩阵:使用\begin{matrix}…\end{matrix} 这样的形式来表示矩阵,在\begin 与\end 之间加入矩阵中的元素即可。矩阵的行之间使用\\ 分隔,列之间使用& 分隔,例如
$$
\begin{matrix}
1 & x & x^2 \\
1 & y & y^2 \\
1 & z & z^2 \\
\end{matrix}
$$
如果要对矩阵加括号,可以像上文中提到的一样,使用\left 与\right 配合表示括号符号。也可以使用特殊的matrix 。即替换\begin{matrix}…\end{matrix} 中matrix 为pmatrix ,bmatrix ,Bmatrix ,vmatrix , Vmatrix 。

其他需要查阅文档

代码

1.单行代码

代码左右分别用一个反引号 `

语法:

`代码内容`

2.代码块

代码之间分别用三个反引号 ``` ,且两边的反引号单独占一行。

语法:

```

代码内容

代码内容

``` 语法高亮需要在```后面加上空格和语言名称即可

``` javascript function print () { console.log('hello world') } ```

任务列表

- [ ] 任务一 未做任务 `- + 空格 + [ ]`
	- [ ] 任务三 
- [x] 任务二 已做任务 `- + 空格 + [x]` 

表格

表头|表头|表头
---|:--:|---:
内容|内容|内容
内容|内容|内容

第二行分割表头和内容。
- 有一个就行,为了对齐,多加了几个
文字默认居左
-两边加:表示文字居中
-右边加:表示文字居右
注:原生的语法两边都要用 | 包起来。此处省略


第一格表头 | 第二格表头
:--------- | :------------:
内容单元格 第一列第一格 | 内容单元格第二列第一格
内容单元格 第一列第二格 多加文字 | 内容单元格第二列第二格

删除线

加删除线像这样用: ~~删除这些~~

脚注

这是一个脚注:[^1] 

[^1]: 这里是脚注信息

TOC

根据标题生成引用目录,能点击目录自动跳转到对应目录

[TOC]

换行

在行尾添加两个空格加回车表示换行

在行尾添加两个空格加回车表示  

换行

流程图

横向流程图源码格式:

graph LR
A[方形] -->B(圆角)
    B --> C{条件a}
    C -->|a=1| D[结果1]
    C -->|a=2| E[结果2]
    F[横向流程图]

竖向流程图源码格式:

graph TD
A[方形] --> B(圆角)
    B --> C{条件a}
    C --> |a=1| D[结果1]
    C --> |a=2| E[结果2]
    F[竖向流程图]

标准流程图源码格式:

st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op

标准流程图源码格式(横向):

st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st(right)->op(right)->cond
cond(yes)->io(bottom)->e
cond(no)->sub1(right)->op

UML时序图源码样例:

对象A->对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象A->对象B: 你真的好吗?

UML时序图源码复杂样例:

Title: 标题:复杂使用
对象A->对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象B->小三: 你好吗
小三-->>对象A: 对象B找我了
对象A->对象B: 你真的好吗?
Note over 小三,对象B: 我们是朋友
participant C
Note right of C: 没人陪我玩

UML标准时序图样例:

%% 时序图例子,-> 直线,-->虚线,->>实线箭头
  sequenceDiagram
    participant 张三
    participant 李四
    张三->王五: 王五你好吗?
    loop 健康检查
        王五->王五: 与疾病战斗
    end
    Note right of 王五: 合理 食物 <br/>看医生...
    李四-->>张三: 很好!
    王五->李四: 你怎么样?
    李四-->王五: 很好!

甘特图样例:

%% 语法示例
        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