跳转至

Markdown 基础语法

Markdown 是一种轻量级标记语言,它允许人们用纯文本格式编写条理性强、格式丰富的文档。

作为技术文档事实的通用语法,Markdown 的主要特点包括:易读写、可扩展、好转换。

爱可帮® AI 智能体的设定描述,核心基于提示词(Prompt)工程,对于结构化的要求非常高,特别适宜使用 Markdown 的语法进行编写。

分级标题

结构化是提示词工程的精髓,合理使用标题,是构建清晰的金字塔结构的不二法门。

Markdown 中的标题语法使用 # 来实现,最多可以使用六级标题,具体语法如下:

标题语法
# H1,一级标题
## H2,二级标题
### H3,三级标题
#### H4,四级标题
##### H5,五级标题
###### H6,六级标题

以下是从提示词工程实践中总结出来的标题用法,请参考使用:

  • H1,用来区隔设定描述的不同组成部分,例如:
    • 角色&任务
    • 技能&规则
    • 参考资料
    • 输出示例
  • H2,用来对一级标题中的组成部分进行进一步的细分
    • 技能中的不同领域的多项技能的归总
    • 参考资料中某个长文本资料的标题
  • H3 ~ H6,根据实际需要进行使用

文本加粗

Markdown 中也支持对段落正文进行单独的格式化,在提示词工程中使用最多的是加粗样式,起强调作用。

加粗语法
**强调,加粗**

强调,用于提示大模型要特别注意的内容,例如规则中的核心要求。

列表

列表的合理化使用,是将文档结构化的另一个重要手段。使用时建议遵守以下原则:

  • 相互之间是次序关系,或者存在重要级差异,优先使用有序列表。
  • 相互之间是平行关系,或者差异性不大,优先使用无序列表。

有序列表的创建方式是在行首使用 阿拉伯数字 ,后跟一个 . ,再加上一个半角空格,如果有多个层级,则用空格进行缩进。具体语法如下:

有序列表语法
1. 第一个项目
    1. 准备
    2. 策划
2. 第二个项目
    1. 准备
    2. 策划
    3. 执行
4. 第三个项目

其中,数字是否递增并不重要,解析时会自动按照递次数字顺序递增,同时根据层级关系自动调整编号的类型。例如,上述 Markdown 文本的最终显示的效果如下:

  1. 第一个项目
    1. 准备
    2. 策划
  2. 第二个项目
    1. 准备
    2. 策划
    3. 执行
  3. 第三个项目
    1. 测试

无序列表的创建方式则是在行首使用 * ,后跟一个空格, 语法如下:

无序列表语法
* I love Apple
  + I love iPhone
    - And I love Mac
* I love Markdown
  + And I use Cursor
  • I love Apple
    • I love iPhone
      • And I love Mac
  • I love Markdown
    • And I use Cursor

表格

Markdown 中支持简单表格的样式,主要用于在参考资料中展示资料来源中的表格,以及在输出示例中定义输出的结构化样式。

表格语法
| 地区(城市) | 省级住宿费标准 | 厅级住宿费标准 | 其他人员住宿费标准 |
| ------ | ------- | ------- | --------- |
| 武汉市    | 800     | 480     | 350       |
| 黄石市    | 800     | 480     | 320       |
| 十堰市    | 800     | 480     | 320       |
| 荆州市    | 800     | 480     | 320       |
| 宜昌市    | 800     | 480     | 320       |
| 襄阳市    | 800     | 480     | 320       |

表格语法的注意事项和展示效果如下:

  • 表格的单元格之间用 | 分隔
  • 表头行下方,必须有 ---- 的分隔行
地区(城市) 省级住宿费标准 厅级住宿费标准 其他人员住宿费标准
武汉市 800 480 350
黄石市 800 480 320
十堰市 800 480 320
荆州市 800 480 320
宜昌市 800 480 320
襄阳市 800 480 320

分隔线

某些时候,为了更清晰的分割文本内容,可以使用三个 *** 来生成一条分隔线。

分隔线语法
***

空行

Markdown 中的空行,是 Markdown 语法中非常重要的组成部分。

一般而言,需要在段落之间添加空行,以确保文本的结构清晰。而在列表和表格中,不要添加空行,否则会破坏列表和表格的结构。

整体示例
Markdown 是一种轻量级标记语言,它允许人们用纯文本格式编写条理性强、格式丰富的文档。

爱可帮® AI 智能体的`设定描述`,核心基于提示词(Prompt)工程,对于结构化的要求非常高,特别适宜使用 Markdown 的语法进行编写。

## 分级标题

结构化是提示词工程的精髓,合理使用标题,是构建清晰的金字塔结构的不二法门。

以下是从提示词工程实践中总结出来的标题用法,请参考使用:

- H1,用来区隔`设定描述`的不同组成部分,例如:
  - 角色&任务
  - 技能&规则

- H2,用来对一级标题中的组成部分进行进一步的细分
  - 技能中的不同领域的多项技能的归总
  - 参考资料中某个长文本资料的标题
- H3 ~ H6,根据实际需要进行使用