Markdown
1、Markdown概述
1.1、什么是Markdown
Markdown是一门轻量级文本标记语言。Markdown的工作过程是将.md
或.markdown
文件解析为HTML输出。
1.2、Markdown能做什么
Markdown是互联网平台最流行的文本标记语言之一。我们常见的网站文章、博客和论文等都可以用它编写。Markdown的文档后缀一般为.md
,导出格式有HTML、Word、PDF、图片图像等。
1.3、Markdown的优点
- 纯文本编辑,语法简单易上手
- 随时修改,不必担心排版问题
- 支持插入图片视频,跨平台同步数据
1.4、Markdown编辑器
- Markdown常用编辑工具:Typora
- 下载链接:传送门
- 国内博客平台:CSDN、博客园、知乎、简书等
2、Markdown基础语法
2.1、标题(ctrl+1~6)
标题级别 | 语法示例 | 字体大小变化 |
---|---|---|
一级标题 | # 一级标题名 | 大 |
二级标题 | ## 二级标题名 | ↓ |
三级标题 | ### 三级标题名 | ↓ |
四级标题 | #### 四级标题名 | ↓ |
五级标题 | ##### 五级标题名 | ↓ |
六级标题 | ###### 六级标题名 | 小 |
注意事项:
#
后面空一格再写标题名- 标题应置于行首,放在表格无法解析
2.2、字体
字体效果 | 语法示例 |
---|---|
粗体(ctrl+B) | **粗体** 或 __粗体__ |
斜体(ctrl+I) | *斜体* 或 _斜体_ |
加粗斜体 | ***加粗斜体*** 或 ___加粗斜体___ |
下划线(ctrl+U) | <u>下划线</u> |
~~删除线~~ | |
Xy | 上标:X<sup>y</sup> |
An | 下标:A<sub>n</sub> |
注意事项:
*
或_
与字体间无空格
字体风格设置见本文3.5节HTML
2.3、换行与段落
1)换行
- 需要换行时插入两个空格
- 需要换行时插入
<br/>
- 一段文本中间插入一个空格
2)段落:Markdown中,段落之间通过空行来区分
2.4、插入图片
语法格式:
![图片描述(可写可不写)](图片地址URL)
图片格式:
- 对齐方式:
#pic_left
(居左)、#pic_center
(居中)、#pic_right
(居右) - 图片大小:对齐方式=宽x高
例如居中且图片大小为100x100:
![图片描述(可写可不写)](图片地址URL#pic_center=100x100)
注意事项:
可直接复制本地图片到编辑处。
2.5、分割线
语法格式:
***
(三个*
)或___
(三个_
)或---
(三个-
)+回车键
2.6、表格(ctrl+T)
语法格式:
语法格式 | 解释 |
---|---|
|表头列1|表头列2|表头列3|......| | 表头的列名间使用|隔开 |
|---|---|---|---| | 表头与内容分割,:-左对齐,-:右对齐,:-:居中对齐 |
|列1内容|列2内容|列3内容|......| | 表内容与列一一对应使用|隔开 |
注意事项:
|表头列1|表头列2|表头列3|......|
后回车可直接生成表结构。
示例:
| 左对齐 | 居中对齐 | 右对齐 |
|:-----|:------:|------:|
| 文本 | 文本 | 文本 |
效果:
左对齐 | 居中对齐 | 右对齐 |
---|---|---|
文本 | 文本 | 文本 |
2.7、列表
- 列表缩进: 减少缩进(ctrl+[)增加缩进(ctrl+])
- 无序列表语法格式:
*
或+
或-
内容(符号+空格+内容)(ctrl+shift+]) - 有序列表语法格式:
数字.
内容(数字+.
+空格+内容)(ctrl+shift+[) - 有层级(嵌套列表)列表语法格式(多层使用Tab键或4个空格缩进):
1)无序列表:
* 第一层
Tab* 第二层
效果:
- 第一层
- 第二层
2)有序列表:
1.1 第一层
Tab1.1.1 第二层
效果:
1.1 第一层
1.1.1 第二层
2.8、链接(ctrl+K)
语法格式:
1)内联链接
[链接名称](链接地址)
或
<a href=链接地址>链接名称</a>
示例1:
[百度一下](https://www.baidu.com)
示例2:
<a href="https://www.baidu.com">百度一下</a>
2)引用链接
[链接名称][引用]
[引用]:链接地址
示例3:
有问题,找[度娘][1]
[1]: https://www.baidu.com
有问题,找度娘
3)图片链接
[![图片描述](图片URL)](链接地址)
点击图片将会跳转到指定的链接地址
4)标题链接
语法格式:@[TOC](标题)
子标题会自动以链接形式在标题下显示
2.9、代码块(ctrl+shift+K)
语法格式:
例如C语言的代码块:
```c
+回车键
例如MySQL的代码块:
```mysql
+回车键
例如Java的代码块:
```java
+回车键
效果:
```java
// 代码块;
```
2.10、特殊符号
- 符号前加反斜杠
\
用来转义符号本身 - 两个反引号
``
包裹用于转义Markdown语法代码块
2.11、引用
语法格式(可嵌套):
>引用内容
>>引用内容1
>>>引用内容2
效果:
引用内容
引用内容1
引用内容2
2.12、脚注
语法格式:
例句:Markdown[^1]
文档可直接转换为HTML[^2]
。
[^1]
:Markdown注释说明
[^2]
:HTML注释说明
3、Markdown高级语法
3.1、公式
Markdown公式可以通过LaTeX数学公式实现
- 行内显示语法:
$公式$
示例1:$f(x) = x-x^2ln(x)$
:
f
(
x
)
=
x
−
x
2
l
n
(
x
)
f(x) = x-x^2ln(x)
f(x)=x−x2ln(x)
- 块内显示语法:
$$公式$$
示例2:$$\sum_{n=1}^{100} n$$
:
∑
n
=
1
100
n
\sum_{n=1}^{100} n
n=1∑100n
-
上标:
X^y^
或X^y
:Xy -
下标:
A~n~
或A_n
:An -
上下标:
$C_n^m$
: C n m C_n^m Cnm
更多符号、数学公式和LaTeX的介绍详见本文3.8节
3.2、标准流程图
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
e=>end: 结束框
st->op->cond
cond(yes)->e
cond(no)->op
3.3、UML时序图
对象A->对象B:对象A发出(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述
对象B-->对象A: 对象B(响应)
3.4、甘特图
gantt
title 软件开发流程
section 设计
需求 :des1, 2022-10-08, 3d
UI设计 :des2, after des1, 3d
开发任务 :des3, after des2, 9d
测试任务 :des4, after des3, 6d
section 开发
准备 :s1, after des1,1d
设计框架 :crit, done, after s1, 3d
开发 :crit, active, 8d
section 测试
功能测试 :a1, after des3, 3d
压力测试 :a2, after a1, 1d
测试报告 :a3, after a2, 2d
3.5、HTML
<table>
<tr>
<th rowspan="2">值班人员</th>
<th><font face="宋体" color=green size=4>星期一</font></th>
<th><font face="宋体" color=red size=4>星期二</font></th>
<th>星期三</th>
</tr>
<tr>
<td>张三</td>
<td>李四</td>
<td>王五</td>
</tr>
</table>
值班人员 | 星期一 | 星期二 | 星期三 |
---|---|---|---|
张三 | 李四 | 王五 |
注意事项:
Markdown本身没有提供修改字体颜色大小等风格设置的语法,需要使用HTML实现。
例如:
<font face="宋体" color=red size=3>宋体红色</font> 或
<font face="宋体" color=FF0000 size=3>宋体红色</font>
效果:宋体红色
color:用于设置字体颜色;face:用于设置字体类型;size:用于设置字体大小
常用字体颜色有:
Color | Color HEX | Color Name |
---|---|---|
红色 | #FF0000 | red |
绿色 | #008000 | green |
蓝色 | #0000FF | blue |
橙色 | #FF7D00 | orange |
黄色 | #FFFF00 | yellow |
紫色 | #800080 | purple |
青色 | #00FFFF | cyan |
金色 | #FFD700 | gold |
棕褐色 | #A52A2A | brown |
橘红色 | #FF7F50 | coral |
深粉色 | #FF1493 | deeppink |
紫红色 | #FF00FF | fuchsia |
深蓝色 | #000080 | navy |
蓝绿色 | #008080 | teal |
深橙色 | #FF8C00 | darkorange |
春绿色 | #00FF7F | springgreen |
橄榄绿 | #808000 | olive |
番茄色 | #FF6347 | tomato |
暗紫色 | #9400D3 | DarkViolet |
蓝紫色 | #8A2BE2 | BlueViolet |
黑红色 | #8B008B | DarkMagenta |
紫粉色 | #FA06F3 | / |
深天蓝 | #00BFFF | / |
玫瑰红 | #DA70D6 | / |
中春绿色 | #00FA9A | / |
中海洋绿 | #3CB371 | / |
闪光深绿 | #32CD32 | / |
浅海洋绿 | #20B2AA | / |
常用字体类型有:
Face | Type |
---|---|
微软雅黑 | 微软雅黑 |
黑体 | 黑体 |
宋体 | 宋体 |
幼圆 | 幼圆 |
楷书 | 楷书 |
华文行楷 | 华文行楷 |
华文隶书 | 华文隶书 |
华文彩云 | 华文彩云 |
3.6、制作待办事项
语法格式:
- []
:待完成事项
- [x]
:已完成事项
示例:
- 待完成事项1
- 待完成事项2
- 已完成事项3
注意事项:
-
后面和[ ]
后面空一格,[ ]
中空一格。
3.7、GFM
GFM(GitHub Flavored Markdown)是GitHub提出的对Markdown的扩展和改进,旨在提供更丰富的功能和更好的渲染效果。
GFM扩展和改进了原始的Markdown规则,提供了以下特性和语法元素:
- 代码块语法:GFM支持使用三个反引号 ` 以及代码块的语言类型来创建代码块,使代码显示更清晰
- 表格语法:GFM引入了表格语法,可以创建复杂的表格,包括设置表头、对齐方式等
- 任务列表:GFM支持在列表中创建任务列表,方便记录任务的完成状态
- 删除线:GFM使用两个波浪线
~~
来表示删除线,用于标记被删除或不推荐使用的文本 - 自动链接:GFM自动将符合URL或邮箱格式的文本转换为链接,无需使用链接语法
- @提及和引用:GFM支持使用
@用户名
提及其他GitHub用户,并自动生成链接 - Emoji表情:GFM支持使用Emoji表情符号,增加了文档的表现力和趣味性
这些扩展和改进使GFM在文档编写中更加灵活和强大,适用于更多的应用场景,使得Markdown文档更具表现力和互动性。
Emoji表情示例:
要在GFM中使用Emoji表情符号,可以使用Emoji的名称或Unicode编码:
语法::smile:或😄
效果:😄
更多icon和表情符号及使用参考:https://blog.csdn.net/Xminyang/article/details/124566884
3.8、LaTeX
更多关于LaTeX的详解和使用参考:https://freeopen.github.io/mathjax/