markdown编写规则

介绍

文件后缀

.md .markdown

编辑器

• Typora
• sublime Text
• coderunner
• vscode (下载对应的markdown插件)

语法

标题

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

换行

<br/>

字体

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

分割线

***

* * *

****

---

- - -

删除线 下划线

<u>下划线<u>

分点条列

* 第一行
* 第二行
- 第一行
- 第二行
+ 第一行
+ 第二行

• 第一行
• 第二行

• 第一行
• 第二行

• 第一行
• 第二行

有序

1. 第一行
   - 第一行

1. 第一行
   • 第一行
   • 第二行

区块

> markdown
>> 基础

markdown

基础

区块+排序

>1. 第一项
>> 1. 第一项
>>> + 第一项

1. 第一项

1. 第一项

• 第一项

代码

` ` ` java 
` ` `

链接

[链接名称]（链接地址） 或者<链接地址>

[百度]（http://www.baidu.com）

图片

![图片描述信息]（图片地址）

! 图片

表格

|  表头 | 表头 |
| ----- |-----|
|单元格 | 单元格|

表头	表头
单元格	单元格

支持html

如：

<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd>

Ctrl+Alt+Del

流程图绘制

mermaid

方向

• TB 从上到下
• BT 从下到上
• RL 从右到左
• LR 从左到右

实例：
从上到下A–>B

基本图形

• id[文字描述] 矩形

• id(文字描述) 圆角矩形

• id>文件描述] 不对称矩形

• id{文字描述} 菱形

• id((文字描述)) 圆形

节点间的连接

• A --> B A带箭头指向B
• A — B A不带箭头指向B
• A -.- B A用虚线指向B
• A -.-> B A用带箭头的虚线指向B
• A ==> B A用加粗的箭头指向B
• A – 描述 — B A不带箭头指向B并在中间加上文字描述
• A – 描述 --> B A带箭头指向B并在中间加上文字描述
• A -. 描述 .-> B A用带箭头的虚线指向B并在中间加上文字描述
• A == 描述 ==> B A用加粗的箭头指向B并在中间加上文字描述

demo

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

思维导图

可以使用Vscode中的markmap组件

花括号

1. 左花括号

$$
大括号示例
\begin{cases}
内容1 \\
内容展示2 \\
内容3 \\
内容展示4
\end{cases}
$$

$$大括号示例\{\begin{array}{l}内容1\\ 内容展示2\\ 内容3\\ 内容展示4\end{array}$$

2. 右花括号

$$
\left.
\begin{aligned}
内容1 \\
内容展示2 \\
内容3 \\
内容展示4
\end{aligned}
\right\}
大括号示例
$$

$$\begin{array}{r}内容1\\ 内容展示2\\ 内容3\\ 内容展示4\end{array}\}大括号示例$$
3. 花括号对

$$
大括号示例
\left\{
\begin{aligned}
内容1 \\
内容展示2 \\
内容3 \\
内容展示4
\end{aligned}
\right\}
$$

$$大括号示例\left\{\begin{array}{r}内容1\\ 内容展示2\\ 内容3\\ 内容展示4\end{array}\right\}$$

4. 带描述信息

$$
大括号示例
\begin{cases}
内容1 & 描述 \\
内容展示2 & 描述 \\
内容3 & 描述 \\
内容展示4 & 描述
\\end{cases}
$$

$$大括号示例\{\begin{array}{ll}内容1& 描述\\ 内容展示2& 描述2\\ 内容3& 描述3\\ 内容展示4& 描述4\end{array}$$

对齐

• cases 左对齐 或者右对齐 根据括号位置
• matrix 居中显示

空格

\quad