Markdown常用的12个语法

最新推荐文章于 2024-07-29 23:56:34 发布

AAROZ

最新推荐文章于 2024-07-29 23:56:34 发布

阅读量304

点赞数

分类专栏：项目管理文章标签： markdown 项目管理

原文链接：http://note.youdao.com/iyoudao/?p=2411

版权

项目管理专栏收录该内容

1 篇文章 0 订阅

订阅专栏

表格序号：6

1 标题

标题是每篇文章必备而且最常用的格式。

在Markdown中，如果想将一段文字定义为标题，只需要在这段文字前面加上 #，再在 # 后加一个空格即可。还可增加二、三、四、五、六级标题，总共六级，只需要增加 # ，增加一个 # ，标题字号相应降低一级。

效果：

一级标题

二级标题

三级标题

四级标题

代码：

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

2 列表

列表格式也很常用，它可以让你的文稿变得井井有条。在 Markdown 中，你只需要在文字前面加上- + * 任何一种就可以了；如果你希望是有序列表，在文字前面加上==1. 2. 3.==即可。

*注：-、1.和文字之间要保留一个字符的空格。

效果：

无序列表

列表1
- 列表1.1
- 列表1.2
列表2
列表3

有序列表

列表1
1. 列表1.1
2. 列表1.2
列表2
列表3

代码：

`无序列表`
- 列表1
	+ 列表1.1
	* 列表1.2
- 列表2
- 列表3

`有序列表`
1. 列表1
	1. 列表1.1
	2. 列表1.2
2. 列表2
3. 列表3

3 引用

如果你需要在文稿中引用一段别处的句子，那么就要用到引用格式。

在引用文字前加上>并与文字保留一个字符的空格，即可。

效果：

引用1

引用2

引用3

代码：

>引用1
>>引用2
>>>引用3

4 字样

要加粗的文字左右分别用两个*包起来

要倾斜的文字左右分别用一个*包起来

要***倾斜和加粗**的文字左右==分别用三个包起来==

要加~~删除线~~ 的文字左右分别用两个~包起来

要加标记的文字左右分别用两个=包起来

*注：符号与文本之间无需空格。

效果：

这是粗体

这是斜体

这是粗斜体

~~这是删除体~~

这是标记体

其他：
H₂O
2¹⁰ = 1024

代码：

**这是粗体**

*这是斜体*

***这是粗斜体***

~~这是删除体~~ 

==这是标记体==

其他：
H~2~O
2^10^ = 1024

5 链接与图片

链接：在 Markdown 中，插入链接只需要使用[显示文本](链接地址 "链接注解")即可。

图片：在 Markdown 中，插入图片只需要使用![图片标题](图片链接地址 ''图片注解'')即可。

*注：注解可加可不加

效果：

链接

代码：

[链接](https://www.csdn.net/ "CSDN")
![图片](https://i-blog.csdnimg.cn/blog_migrate/b3b0352a462f3047e6f5a3a21fc793fb.png "CSDN")

6 分割线

分割线的语法只需要另起一行，连续输入三个星号***即可分割两段文字内容。

效果：

第一段内容

第二段内容

代码：

第一段内容
***
第二段内容

7 表格

列居左:-
列居中:-:
列居右-:

效果：

标题1	标题二	标题3
1	A	!
2	B	@
3	C	#

代码：

|标题1|标题二|标题3|
|:-|:-:|-:|
|1|A|!|
|2|B|@|
|3|C|#|

8 代码高亮

在代码上一行和下一行加上```（反引号)即可

效果：

代码

9 制作待办事项To-do List

如下

效果：

已完成事项1
- 已完成事项2
- 已完成事项3
待办事项1
待办事项2

代码：

- [x] 已完成事项1
	- [x] 已完成事项2
	- [x] 已完成事项3
- [ ] 待办事项1
- [ ] 待办事项2

10 换行

两段文字之间加<br>即可

效果：

第一行
第二行

第三行

代码：

第一行<br>第二行<br>
第三行

11 流程图

在Markdown中，一段流程图语法以三个反引号mermaid开头，以三个反引号结尾。

在反引号后另起一行，书写graph XX，用以确定将要绘制的流程图及其类型（XX表示流程图类型）。

流程图分为竖向和横向两大类，竖向包括自上而下和自下而上两种顺序，横向包括从右到左和从左到右两种顺序。

其对应语法分别为：graph TB/graph BT/graph RL/graph LR。

我们可以通过调整语法来调整流程图的框线、连接线，不同条件能导向不同结果。

TB - top bottom（自上而下）
BT - bottom top（自下而上）
RL - right left（从右到左）
LR - left right（从左到右）

效果：

自上而下

自下而上

从左到右

从右到左

完整案例

代码：

###### 自上而下
三个` mermaid
graph TB
A-->B
三个反引号

###### 自下而上
三个` mermaid
graph BT
A-->B
三个`

###### 从左到右
三个` mermaid
graph LR
A-->B
三个反引号

###### 从右到左
三个` mermaid
graph RL
A-->B
三个`

###### 完整案例
三个` mermaid
graph TB
	A[Christmas] --> B(Go shopping)
	B --> C{Let me think}
	C --> |One| D[Laptop]
	C --> |Two| E[iphone]
	C --> |Three| F[Car]
三个`

11 流程图

与流程图一样，Markdown中，甘特图的语法也是以三个反引号mermaid开头，以三个反引号结尾。

在反引号后另起一行，书写gantt，用以确定将要绘制的是甘特图。

如需按项目进行划分，需键入section，空一个字符，再输入项目名称的文本（一个section和另一个section之间要空行）。

每个大项目将拆解为若干个小任务，只需在section之后另起一行，直接输入小项目名称即可。

注：dateFormat YYYY-MM-DD规定了时间轴，title (标题文本)表示甘特图标题。

效果：

代码：

三个` mermaid
gantt
	dateFormat YYYY-MM-DD
	title 产品计划表
	section 初期阶段
	明确需求: 2016-03-01, 10d
	section 中期阶段
	跟进开发: 2016-03-11, 15d
	section 后期阶段
	走查测试: 2016-03-20, 9d
三个`