markdown语法笔记
参考: http://xianbai.me/learn-md/index.html
参考: https://www.runoob.com/markdown/md-tutorial.html
1.标题设置
//设置标题 快捷键:ctrl+数字1~6
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
2.段落设置
使用空行分隔一行或多行文本,
不应使用空格或制表符缩进段落
使用空行分隔一行或多行文本,
不应使用空格或制表符缩进段落
3.换行
两个或多个空格结束一行 + 回车
也可直接嵌入html标签:<br/>在某些编辑器里可以直接回车
两个或多个空格结束一行 + 回车
也可直接嵌入html标签:
在某些编辑器里可以直接回车
4.分隔线
你可以在一行中用三个以上的星号、减号、下划线来建立一个分隔线,行内不能有其他东西。
***
------
________
4.字体格式
**加粗字体** //CTRL+B
*倾斜字体* //CTRL+I
_倾斜字体_
***加粗倾斜字体*** //CTRL+I+B
___加粗倾斜字体___
~~删除线~~
<U>下划线字体</u> //html格式
H~2~O //下标CSDN支持
2^10^ //上标CSDN支持
这是要加脚注的文字[^注1]:
[^注1]: 这是注解文字
加粗字体
倾斜字体
倾斜字体
加粗倾斜字体
加粗倾斜字体
删除线字体
下划线字体
H2O 下标
210 上标
这是要加脚注的文字1:
5.列表和区块引用
5.1列表
无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记:
* 这是第一项
* 这是第二项
* 这是第三项
有序列表使用数字并加上 . 号来表示
1. 这是第一项
2. 这是第二项
3. 这是第三项
列表嵌套
列表嵌套在子列表中的选项末尾回车,然后删除新增父列表的标号即可添加新的列表
也可在新起的一行添加四个空格即可
-
这是第一项
-
这是第一项
-
这是第一项
-
这是第一项
-
这是第二项
-
这是第三项
-
第一项:
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
-
第二项:
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素
5.2区块引用
> 最外层
> > 第一层嵌套
> > > 第二层嵌套
最外层
第一层嵌套
第二层嵌套
5.3列表与引用的嵌套
1. 第一项
2. 第二项
> 区块引用1
> 区块引用2
> + 第一项
> + 第二项
> + 第三项
- 第一项
- 第二项
区块引用1
区块引用2
- 第一项
- 第二项
- 第三项
6.代码输入
语句片段
`printf()`
`z=x+y`
代码区块使用 4 个空格或者一个制表符(Tab 键)
int markdown{
run();
}
指定语言的代码块
```c++
int cppEdit{
run();
return 0;
}
函数或语句片段
printf()
z=x+y
函数片段
int markdown{
run();
}
指定语言的代码块
int cppEdit{
run();
return 0;
}
7.链接
[链接名称](链接地址)
或者
<链接地址>
链接也可以用变量来代替,文档末尾附带变量地址:
这个链接用 1 作为网址变量 [Google][1]
然后在文档的结尾为变量赋值(网址)
[1]: http://www.google.com/
这个链接用 1 作为网址变量 Google
8.图片
![alt 替代文本](图片地址)
![alt 替代文本](图片地址 "可选标题")
markdown不支持图片的大小调整,但是可以通过插入<img>标签实现
<img src="https://i-blog.csdnimg.cn/blog_migrate/1722b5a02ba305e0f942c1ac75a22428.png" alt="百度一下" title="百度一下" width="400" height="50" />
![百度一下 百度一下](https://i-blog.csdnimg.cn/blog_migrate/1722b5a02ba305e0f942c1ac75a22428.png)
9.表格
Markdown 制作表格使用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行。
| 表头 | 表头 |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
设置表格的对齐方式:
-: 设置内容和标题栏居右对齐。
:- 设置内容和标题栏居左对齐。
:-: 设置内容和标题栏居中对齐。
| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
注意:左右两侧的|可以省去
左对齐 | 右对齐 | 居中对齐 |
---|---|---|
单元格 | 单元格 | 单元格 |
单元格 | 单元格 | 单元格 |
10.转义字符
Markdown 使用反斜杠转义特殊字符
支持以下符号前面加上反斜杠来帮助插入普通的符号
\ 反斜线
` 反引号
* 星号
_ 下划线
{} 花括号
[] 方括号
() 小括号
# 井字号
+ 加号
- 减号
. 英文句点
! 感叹号
11.插入数学公式
使用美元符号插入数学公式
$$xyz$$
12.画图
1、横向流程图源码格式:
```mermaid
graph LR
A[方形] -->B(圆角)
B --> C{条件a}
C -->|a=1| D[结果1]
C -->|a=2| E[结果2]
F[横向流程图]
```
2、竖向流程图源码格式:
```mermaid
graph TD
A[方形] --> B(圆角)
B --> C{条件a}
C --> |a=1| D[结果1]
C --> |a=2| E[结果2]
F[竖向流程图]
```
3、标准流程图源码格式:
```mermaid
flowchat
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、标准流程图源码格式(横向):
```mermaid
flowchat
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时序图源码样例:
```mermaid
sequenceDiagram
对象A->>对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->>对象A: 我很好(响应)
对象A->>对象B: 你真的好吗?
```
6、UML时序图源码复杂样例:
```mermaid
sequenceDiagram
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标准时序图样例:
```mermaid
%% 时序图例子,-> 直线,-->虚线,->>实线箭头
sequenceDiagram
participant 张三
participant 李四
张三->王五: 王五你好吗?
loop 健康检查
王五->王五: 与疾病战斗
end
Note right of 王五: 合理 食物 <br/>看医生...
李四-->>张三: 很好!
王五->李四: 你怎么样?
李四-->王五: 很好!
```
8、甘特图样例:
```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
s4, 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
这是注解文字 ↩︎