首页
  • 上位机
  • 嵌入式
  • AI
  • Web
教程
MarkDown语法
有趣的项目
其他
GitHub
首页
  • 上位机
  • 嵌入式
  • AI
  • Web
教程
MarkDown语法
有趣的项目
其他
GitHub
  • MarkDown 语法教程

MarkDown 语法教程

1. 标题

语法

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

2. 段落与换行

效果

这是第一段文字。

这是第二段文字,中间有空行分隔。

这是同一段内的
强制换行(行尾加两个空格)

语法

这是第一段文字。

这是第二段文字,中间有空行分隔。

这是同一段内的  
强制换行(行尾加两个空格)

3. 强调

效果

斜体文本
另一种斜体

粗体文本
另一种粗体

删除线文本

语法

*斜体文本*  
_另一种斜体_  

**粗体文本**  
__另一种粗体__  

~~删除线文本~~

4. 列表

无序列表效果

  • 项目一
  • 项目二
    • 子项目一
    • 子项目二

无序列表语法

- 项目一
- 项目二
  - 子项目一
  - 子项目二

有序列表效果

  1. 第一项
  2. 第二项
    1. 子项一
    2. 子项二

有序列表语法

1. 第一项
2. 第二项
   1. 子项一
   2. 子项二

5. 链接与图片

链接效果

百度

链接语法

[百度](https://www.baidu.com)

图片效果

Markdown图标

图片语法

![Markdown图标](https://markdownlogo.com/images/logo.png)

6. 代码

行内代码效果

使用printf()函数打印输出

行内代码语法

使用`printf()`函数打印输出

代码块效果

def hello():
    print("Hello, World!")

代码块语法

```python
def hello():
    print("Hello, World!")
```

7. 表格

效果

姓名年龄职业
张三25工程师
李四30设计师

语法

| 姓名 | 年龄 | 职业 |
|------|-----|------|
| 张三 | 25  | 工程师 |
| 李四 | 30  | 设计师 |

8. 引用

效果

这是一个引用

引用可以多行 也可以嵌套

嵌套引用

语法

> 这是一个引用
>
> 引用可以多行
> 也可以嵌套
>> 嵌套引用

9. 分割线

效果

上面内容


下面内容

语法

上面内容

---

下面内容

Mermaid 语法教程

1. 流程图 (Flowchart)

效果

语法

```mermaid
graph TD
    A[开始] --> B{条件判断}
    B -->|是| C[执行操作1]
    B -->|否| D[执行操作2]
    C --> E[结束]
    D --> E
```

说明

  • graph TD 表示从上到下的流程图
  • A[开始] 表示矩形节点
  • B{条件判断} 表示菱形条件节点
  • --> 表示箭头连接
  • -->|是| 表示带文字的箭头连接

2. 序列图 (Sequence Diagram)

效果

语法

```mermaid
sequenceDiagram
    participant 用户
    participant 系统
    
    用户->>系统: 登录请求
    系统-->>用户: 登录成功
    用户->>系统: 查询数据
    系统-->>用户: 返回结果
```

说明

  • sequenceDiagram 声明序列图
  • participant 定义参与者
  • ->> 实线箭头表示同步消息
  • -->> 虚线箭头表示异步消息

3. 类图 (Class Diagram)

效果

语法

```mermaid
classDiagram
    class 用户 {
        +String 用户名
        +String 密码
        +登录()
        +注销()
    }
    
    class 订单 {
        +int 订单号
        +Date 创建时间
        +提交订单()
    }
    
    用户 "1" --> "n" 订单
```

说明

  • classDiagram 声明类图
  • + 表示公共成员
  • "1" --> "n" 表示一对多关系

4. 甘特图 (Gantt Chart)

效果

语法

```mermaid
gantt
    title 项目计划
    dateFormat  YYYY-MM-DD
    section 设计
    需求分析      :done,    des1, 2023-01-01, 7d
    原型设计      :active,  des2, 2023-01-08, 5d
    section 开发
    前端开发      :         dev1, 2023-01-15, 10d
    后端开发      :         dev2, after dev1, 5d
```

说明

  • gantt 声明甘特图
  • title 设置标题
  • dateFormat 设置日期格式
  • section 定义任务分组
  • :done, 表示已完成任务
  • :active, 表示进行中任务
  • after 表示任务依赖关系

5. 饼图 (Pie Chart)

效果

语法

```mermaid
pie
    title 浏览器市场份额
    "Chrome" : 65.2
    "Safari" : 18.3
    "Firefox" : 8.7
    "Edge" : 4.1
    "其他" : 3.7
```

说明

  • pie 声明饼图
  • title 设置标题
  • 每个数据项格式为 "标签" : 值

6. 状态图 (State Diagram)

效果

语法

```mermaid
stateDiagram-v2
    [*] --> 待机
    待机 --> 运行 : 启动
    运行 --> 暂停 : 暂停按钮
    暂停 --> 运行 : 继续按钮
    运行 --> 待机 : 停止
    暂停 --> 待机 : 停止
```

说明

  • stateDiagram-v2 声明状态图
  • [*] 表示初始状态
  • --> 表示状态转换
  • : 标签 表示转换条件

7.常用技巧

  1. 换行处理:
graph LR
    A[第一行<br>第二行]
  1. 样式定制
  1. 注释写法:
graph LR
    %% 这是单行注释
    A --> B

  1. 连接线样式:
graph LR
    A-- 普通连线 -->B
    A-. 虚线 .->C
    A== 粗线 ==>D

Prev
Home