markdown的基本语法使用

Scroll Down

ATOM下载地址

ATOM

配置

打开 文件->设置->安装
搜索并安装以下插件
预览插件:markdown-preview-enhanced
markdown编辑器:markdown-writer
中文汉化:simplified-chinese-menu

基本语法


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

一级标题

二级标题

三级标题

四级标题


~~删除线~~

**加粗**

*斜体*

***加粗斜体***

删除线

加粗

斜体

加粗斜体



    ```
    代码块
    ```

    `代码`

代码块

代码

分割线

最少三个 -或* 如:---

有序列表
1. 发发发
2. 是是是
    + 发发发
    + 反反复复

无序列表
+ ffffff
- sssss
* sssss

有序列表

  1. 发发发
  2. 是是是
    • 发发发
    • 反反复复

无序列表

  • ffffff
  • sssss
  • sssss

- [ ] 待办
- [x] 已办

引用
 > 撒地方的
 > 阿斯顿发送到
  •  待办
  •  已办

引用

撒地方的
阿斯顿发送到


姓名 | 年龄 | 性别
:---|:---:|---:
张三 | 4 | 男

姓名 | 年龄 | 性别
:---|:---:|---:
张三 | 4 | 男

markdown 跳转

目录实现
* [一级标题](#一级标题)
    * [二级标题](#二级标题)
        * [三级标题](#三级标题)
            * [四级标题](#四级标题)

图片
![https://www.gnsoft.ltd/avatar](https://www.gnsoft.ltd/avatar)
链接
[https://www.gnsoft.ltd](https://www.gnsoft.ltd "G的博客")

表情
:relaxed:

markdown 跳转

目录实现

图片
https://www.gnsoft.ltd/avatar
链接
https://www.gnsoft.ltd

表情

表情查询


流程图

	```mermaid
		graph TD
    		id[带文本的矩形]
    		id4(带文本的圆角矩形)
    		id3>带文本的不对称的矩形]
    		id1{带文本的菱形}
    		id2((带文本的圆形))
	```
graph TD id[带文本的矩形] id4(带文本的圆角矩形) id3>带文本的不对称的矩形] id1{带文本的菱形} id2((带文本的圆形))
	```mermaid
		graph TB
    		c1-->a2
    		subgraph one
    		a1-->a2
    		end
    		subgraph two
    		b1-->b2
    		end
    		subgraph three
    		c1-->c2
    		end
	```
graph TB c1-->a2 subgraph one a1-->a2 end subgraph two b1-->b2 end subgraph three c1-->c2 end
	```mermaid
		graph LR
    		start[开始] --> input[输入A,B,C]
    		input --> conditionA{A是否大于B}
    		conditionA -- YES --> conditionC{A是否大于C}
    		conditionA -- NO --> conditionB{B是否大于C}
    		conditionC -- YES --> printA[输出A]
    		conditionC -- NO --> printC[输出C]
    		conditionB -- YES --> printB[输出B]
    		conditionB -- NO --> printC[输出C]
    		printA --> stop[结束]
    		printC --> stop
    		printB --> stop
	```
graph LR start[开始] --> input[输入A,B,C] input --> conditionA{A是否大于B} conditionA -- YES --> conditionC{A是否大于C} conditionA -- NO --> conditionB{B是否大于C} conditionC -- YES --> printA[输出A] conditionC -- NO --> printC[输出C] conditionB -- YES --> printB[输出B] conditionB -- NO --> printC[输出C] printA --> stop[结束] printC --> stop printB --> stop
饼图
	```mermaid
		pie title NETFLIX
         	"Time spent looking for movie" : 90
         	"Time spent watching it" : 10
	```

饼图

pie title NETFLIX "Time spent looking for movie" : 90 "Time spent watching it" : 10

时序图

基本语法
需要使用 mermaid 解析,并在开头使用关键字 sequenceDiagram 指明
线段的样式遵循 mermaid 的解析方式
-> : 实线连接
--> :虚线连接
->> :实线箭头指向
-->> :虚线箭头指向

	```mermaid
		sequenceDiagram
		对象A->对象B:中午吃什么?
		对象B->>对象A: 随便
		loop 思考
    		对象A->对象A: 努力搜索
		end
		对象A-->>对象B: 火锅?
		对象B->>对象A: 可以
		Note left of 对象A: 我是一个对象A
		Note right of 对象B: 我是一个对象B
		participant 对象C
		Note over 对象C: 我自己说了算
	```
sequenceDiagram 对象A->对象B:中午吃什么? 对象B->>对象A: 随便 loop 思考 对象A->对象A: 努力搜索 end 对象A-->>对象B: 火锅? 对象B->>对象A: 可以 Note left of 对象A: 我是一个对象A Note right of 对象B: 我是一个对象B participant 对象C Note over 对象C: 我自己说了算

甘特图

基本语法:
使用 mermaid 解析语言,在开头使用关键字 gantt 指明
dateFormat 格式 指明日期的显示格式
title 标题 设置图标的标题
section 描述 定义纵向上的一个环节
定义步骤:每个步骤有两种状态 done(已完成)/ active(执行中)
描述: 状态,id,开始日期,结束日期/持续时间
描述: 状态[,id],after id2,持续时间
crit :可用于标记该步骤需要被修正,将高亮显示
如果不指定具体的开始时间或在某个步骤之后,将默认依次顺序排列

	```mermaid
		gantt
        	dateFormat  YYYY-MM-DD

        	title 软件开发甘特图

        	section 设计
        	需求:done,des1, 2019-01-06,2019-01-08
        	原型:active,des2, 2019-01-09, 3d
        	UI设计:des3, after des2, 5d
        	未来任务:des4, after des3, 5d

        	section 开发
        	学习准备理解需求:crit, done, 2019-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, 2019-01-06,2019-01-08 原型:active,des2, 2019-01-09, 3d UI设计:des3, after des2, 5d 未来任务:des4, after des3, 5d section 开发 学习准备理解需求:crit, done, 2019-01-06,24h 设计框架:crit, done, after des2, 2d 开发:crit, active, 3d 未来任务:crit, 5d 休息时间:2d section 测试 功能测试:active, a1, after des3, 3d 压力测试:after a1, 20h 测试报告: 48h


参考链接:
markdown 绘制流程图、时序图、甘特图