基础 | Markdown和Mermaid基础语法

内容纲要

与大模型交互只需要自然语言,但文本的格式也表征重要的信息,比如标题,加粗,序列等。为了更好地与大模型交互,有必要了解一下Markdown和Mermaid的基础语法。

Markdown基础语法

Markdown就像是一种简化版的Word。它让你用简单的符号来格式化文字,而不需要点击按钮或菜单。

你可在线体验Markdown语法, 访问 https://1024tools.com/markdown

或者本地下载支持Markdown语法的编辑器,比如Typora。

以下是最基础的Markdown语法,花5分钟操练下,能满足90%的使用场景。

  1. 标题
    使用 # 号, 一级标题一个 #, 二级标题两个 ##, 以此类推, 最多六级。

  2. 粗体
    用两个 * 包围文字,如 粗体

  3. 斜体
    用一个 包围文字,如 斜体*

  4. 列表

    • 无序列表使用 -
    • 有序列表使用数字加点,如 1. 2. 3.
  5. 链接

    [链接文字](URL)
  6. 图片

    ![图片说明](图片URL)
  7. 引用
    在段落前加 >

  8. 代码

    • 行内代码用 ` 包围
    • 代码块用 ``` 包围,可指定语言
  9. 分割线
    三个或更多的 ---

Mermaid基础语法

Mermaid就像是用文字来画图。你用简单的文字描述,它就能自动生成漂亮的图表。

在线体验Mermaid语法 https://www.min2k.com/tools/mermaid/

Mermaid语法看上去要复杂点,也不用全记住。

需要时,记住,大模型能很好地通过Mermaid语法来理解一套流程。

  1. 流程图
    ```mermaid
    graph TD
    A[开始] --> B{判断}
    B -->|是| C[处理]
    B -->|否| D[结束]
    C --> D
    ```                                      .
  2. </ol>
    <pre><code class="language-mermaid">graph TD
    A[开始] --> B{判断}
    B -->|是| C[处理]
    B -->|否| D[结束]
    C --> D</code></pre>
    <ol start="2">
    <li>时序图
    <pre><code>```mermaid
    sequenceDiagram
    参与者A->>参与者B: 请求
    参与者B->>参与者A: 响应
    ``` .

sequenceDiagram
    参与者A->>参与者B: 请求
    参与者B->>参与者A: 响应
  1. 类图
    ```mermaid
    classDiagram
    类A --|> 类B
    类A : +属性1
    类A : -方法1()
    ```                                      .
  2. </ol>
    <pre><code class="language-mermaid">classDiagram
    类A --|> 类B
    类A : +属性1
    类A : -方法1()</code></pre>
    <ol start="4">
    <li>甘特图
    <pre><code>```mermaid
    gantt
    title 项目进度
    section 阶段1
    任务1 :a1, 2023-01-01, 30d
    任务2 :after a1, 20d
    ``` .

gantt
    title 项目进度
    section 阶段1
    任务1 :a1, 2023-01-01, 30d
    任务2 :after a1, 20d
  1. 饼图
    ```mermaid
    pie
    title 收入分布
    "工资" : 48
    "投资" : 32
    "其他" : 20
    ```                                      .
pie
    title 收入分布
    "工资" : 48
    "投资" : 32
    "其他" : 20

使用Mermaid时,需要将代码块放在 mermaid 和 之间。Mermaid支持多种图表类型,可以根据需要选择合适的图表来可视化你的数据或流程。在支持Mermaid的Markdown编辑器中,这些图表会被自动渲染出来。

Leave a Comment

您的电子邮箱地址不会被公开。 必填项已用*标注

close
arrow_upward