是不是写markdown的时候经常想着这么写比较好看但忘了语法是啥,笔者专门把常用语法汇总方便大家当然主要是方便自己查找,还有一些流程图甘特图的高级用法很好用大家可以看看。

标题的书写

h1 到 h6 的标题分别是从大到小一个到六个#

h1 标题

h2 标题

h3 标题

h4 标题

h5 标题
h6 标题

几种字体

斜体文字

斜体文本

粗体文本

粗体文本

斜体粗体文本

斜体粗体文本

对应语法:

1
2
3
4
5
6
7
8
9
10
11
*斜体文字*

_斜体文本_

**粗体文本**

__粗体文本__

***斜体粗体文本***

___斜体粗体文本___

分割线








对应语法:

1
2
3
4
5
6
7
8
9
10
11
___

******

****

******

*********************

___________________

删除线

删除这段文本

对应语法:

1
~~删除这段文本~~

下划线

给这段文本加上下划线

对应语法:

1
<u>给这段文本加上下划线</u>

注脚

这是一段需要注释的说明[^注释]

对应语法:

1
这是一段需要注释的说明[^注释]

无序列表

  • 第一项
  • 第二项
  • 第一项
  • 第二项

  • 第一项

  • 第二项

    对应语法:

1
2
3
4
5
6
7
8
9
10
11
12
* 第一项
* 第二项



+ 第一项
+ 第二项



- 第一项
- 第二项

有序列表

有序列表就是阿拉伯数字后加点

  1. 第一项
  2. 第二项
  3. 第三项

嵌套列表

嵌套列表只需在子列表中的选项添加四个空格:

  1. 第一项

    ​ 1.1 嵌套第一项

    ​ 1.2 嵌套第二项

区块

这是区块的引用

这是一层嵌套区块的使用

这是二层嵌套区块使用

对应语法:

1
2
3
4
5
> 这是区块的引用
> >这是一层嵌套区块的使用
> >
> > > 这是二层嵌套区块使用
> > >

区块中使用列表和列表中使用区块

  1. 第一项

  2. 第二项

    2.1 第二点一项

    2.2 第二点二项

    • 第二点三项

  • 第一项

    这是列表中嵌套区块

    这是列表中嵌套区块

  1. 这是第一项

    这是列表中嵌套区块

    这是列表中嵌套区块

对应语法:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
> 1. 第一项
>
> 2. 第二项
>
> 2.1 第二点一项
>
> 2.2 第二点二项
>
> * 第二点三项
>
> - 第
>
>

* 第一项

> 这是列表中嵌套区块
>
> 这是列表中嵌套区块

1. 这是第一项

> 这是列表中嵌套区块
>
> 这是列表中嵌套区块

代码

如果段落上是一段函数代码就使用反引号把它包裹起来

fmt.Println("a+b=c ,c+d=e")

对应语法:

1
`fmt.Println("a+b=c ,c+d=e")`

代码区块

代码块使用``` 回车

1
2
3
4
5
func getcode(cd string)(cds string,err error){
s= fmt.Sprintf("这是一个代码块,属于%s语言的",“goland")
cds = cd + s
return
}

链接

链接使用方法如下:

1
2
3
4
5
[链接名称](链接地址)

或者

<链接地址>

这是一个链接https://baidu.com

这是一个链接百度一下你就知道

高级链接

链接可以用变量来代替,文档末尾附带变量地址

使用 1 作为网址变量Google

这个链接使用 2 作为网址变量baidu

在文本末添加真实的链接

对应语法:

1
2
3
4
5
6
7
8
使用 1 作为网址变量[Google][1]

这个链接使用 2 作为网址变量[baidu][2]

在文本末添加真实的链接

[1]:https://google.com
[2]: https://www.baidu.com

图片

1
2
3
![alt 属性文本](图片地址)

![alt 属性文本](图片地址 "可选标题")
  • 开头一个感叹号 !
  • 接着一个方括号,里面放上图片的替代文字
  • 接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 ‘title’ 属性的文字。
1
2
3
![RUNOOB 图标](http://static.runoob.com/images/runoob-logo.png)

![RUNOOB 图标](http://static.runoob.com/images/runoob-logo.png "RUNOOB")

当然,你也可以像网址那样对图片网址使用变量:

1
2
3
4
这个链接用 1 作为网址变量 [RUNOOB][1].
然后在文档的结尾为变量赋值(网址)

[1]: http://static.runoob.com/images/runoob-logo.png

显示结果如下:

img

Markdown 还没有办法指定图片的高度与宽度,如果你需要的话,你可以使用普通的 标签。

1
<img src="http://static.runoob.com/images/runoob-logo.png" width="50%">

表格

Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。

语法格式如下:

1
2
3
4
|  表头   | 表头  |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
表头 表头
单元格 单元格

高级

以下代码需要在markdown代码块中选择 mermaid 类型,在 mermaid代码块中贴入一下代码即可看到对应的流程图结果

1、横向流程图源码格式:

1
2
3
4
5
6
graph LR
A[方形] -->B(圆角)
B --> C{条件a}
C -->|a=1| D[结果1]
C -->|a=2| E[结果2]
F[横向流程图]
1
2
3
4
5
6
7
8
9
10
graph TD
A(获取authkey) -->B(圆角) -->C(创建CSR) -->D(获取自定义验证值) -->E(设置验证值dnsTXTFile)
E -->F(获取证书)
G[获取自定义验证值条件]-->H{共6个步骤}
H -->I[定义窗口时间格式yyyyMMddhhmmss ]
H -->J[拼接CSRPEM]
H -->K[做sha256哈希]
H -->L[大端字节序转换哈希为int]
H -->M[用0补全到不小于50字符]
H -->N[最后用刚刚格式化的窗口时间做前缀]

2、竖向流程图源码格式:

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

3、标准流程图源码格式:

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

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

1
2
3
4
5
6
7
8
9
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

5、UML时序图源码样例:

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

6、UML时序图源码复杂样例:

1
2
3
4
5
6
7
8
9
10
11
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: 没人陪我玩

7、UML标准时序图样例:

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

8、甘特图样例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
%% 语法示例
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