Skip to content

Markdown格式

0
2026-07-29

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

粗体斜体删除线高亮背景颜色这是下划线文本

这是行内数学表达式: nums[i][j]
这是块级公式

f[i][j] = \text{最优值}

int a = 30; // 这是行内代码

/*
可以指定语言sh、bash、c、cpp、python、java等,有对应的语言高亮
*/
这是代码块

引用段落
这是第一层引用。

这是第二层引用。

第三层引用

第四层引用

第五层引用

  • 这是一个勾选框

  • 这是第二个勾选框

- ├ - 分支符号
    
- └ - 最后一项符号
    
- │ - 垂直线
    
- ─ - 水平线
项目目录/
├── src/
│   ├── main.js
│   └── utils.js
└── README.md

你可以直接使用 Unicode 字符来插入箭头:

  • 向右箭头: (Unicode: U+2192)

  • 向左箭头: (Unicode: U+2190)

  • 向上箭头: (Unicode: U+2191)

  • 向下箭头: (Unicode: U+2193)

  • 双向箭头: (Unicode: U+2194)

图表

在 Markdown 中使用 Mermaid 图表时,正确的语法格式应该是:

```mermaid
图表类型
    图表内容
```

Mermaid 支持多种类型的图表,以下是完整的图表类型列表和简要说明:

1. 流程图 (Flowchart)

flowchart TD
    A[开始] --> B[处理数据]
    B --> C{判断}
    C -->|是| D[成功]
    C -->|否| E[失败]
    D --> F[结束]
    E --> F

2. 序列图 (Sequence Diagram)

sequenceDiagram
    participant A as 客户端
    participant B as 服务器
    A->>B: 登录请求
    B->>B: 验证凭证
    B-->>A: 返回结果

3. 类图 (Class Diagram)

classDiagram
    class Animal {
        +String name
        +int age
        +eat()
        +sleep()
    }
    class Dog {
        +bark()
    }
    Animal <|-- Dog

4. 状态图 (State Diagram)

stateDiagram-v2
    [*] --> 待机
    待机 --> 运行: 启动命令
    运行 --> 暂停: 暂停命令
    暂停 --> 运行: 继续命令
    运行 --> 待机: 停止命令
    待机 --> [*]

5. 实体关系图 (ER Diagram)

erDiagram
    CUSTOMER ||--o{ ORDER : places
    ORDER ||--|{ LINE-ITEM : contains
    CUSTOMER {
        string name
        string email
    }

6. 用户旅程图 (User Journey)

journey
    title 用户购物旅程
    section 浏览商品
      查看列表: 5: 用户
      点击详情: 4: 用户
    section 下单支付
      添加购物车: 5: 用户
      完成支付: 3: 用户

7. 甘特图 (Gantt)

gantt
    title 项目开发计划
    dateFormat YYYY-MM-DD
    section 设计
    需求分析: 2024-01-01, 7d
    UI设计: 2024-01-08, 5d
    section 开发
    前端开发: 2024-01-15, 10d
    后端开发: 2024-01-15, 12d

8. 饼图 (Pie)

pie title 编程语言使用率
    "JavaScript" : 42
    "Python" : 25
    "Java" : 15
    "其他" : 18

9. 象限图 (Quadrant Chart)

quadrantChart
    title 技术评估矩阵
    x-axis "低复杂度" --> "高复杂度"
    y-axis "低价值" --> "高价值"
    "IAP技术": [0.2, 0.8]
    "OTA系统": [0.7, 0.9]
    "基础驱动": [0.3, 0.4]
    "实验功能": [0.8, 0.3]

10. 需求图 (Requirement Diagram)

渲染失败

requirementDiagram
    requirement 功能需求 {
        id: REQ_001
        text: 系统必须支持OTA升级
        risk: 高
        verifymethod: 测试
    }
    
    requirement 性能需求 {
        id: REQ_002
        text: 升级时间小于5分钟
        risk: 中
        verifymethod: 测量
    }

11. Git图 (Git Graph)

gitGraph
    commit id: "初始化"
    commit id: "添加IAP功能"
    branch feature/ota
    checkout feature/ota
    commit id: "实现OTA基础框架"
    commit id: "完成差分升级"
    checkout main
    commit id: "修复IAPbug"
    merge feature/ota
    commit id: "发布v1.0"

12. 时间线 (Timeline)

timeline
    title 嵌入式技术发展
    2000-2010 : 基础IAP技术<br>有线升级方式
    2010-2020 : OTA技术兴起<br>物联网设备普及
    2020至今 : 安全OTA<br>差分升级<br>A/B分区

13. C4模型 (Context/Container/Component/Code)

C4Context
    title 系统上下文图
    Person(用户, "设备用户", "通过APP操作设备")
    System(设备, "智能设备", "提供IAP和OTA功能")
    System_Ext(云平台, "云服务平台")
    
    Rel(用户, 设备, "使用")
    Rel(设备, 云平台, "连接并下载固件")

14. 思维导图 (Mindmap)

mindmap
    root((嵌入式升级技术))
        IAP技术
             Bootloader
             Flash操作
             通信协议
        OTA系统
             无线传输
             云端管理
             安全验证
             差分升级
        应用场景
             物联网设备
             工业控制器
             消费电子

15. 包图 (Package Diagram)

packageDiagram
    package "嵌入式固件" {
        [Bootloader] --> [应用程序]
        [应用程序] --> [硬件驱动]
    }
    
    package "云端服务" {
        [固件管理] --> [设备管理]
    }
    
    [应用程序] ..> [固件管理] : 通信

使用提示

  1. 语法格式:所有图表都使用相同的代码块格式

  2. 在线编辑器:可以在 Mermaid Live Editor 中实时编辑和预览

  3. 渲染支持:需要确保你的 Markdown 渲染器支持 Mermaid

  4. 组合使用:可以在一个文档中混合使用多种图表类型