并排对比(compare)
把两到三种方案左右并列,对比各自的取舍与属性。
只贴一段 diff
读者只看到增删行;前面没有完整代码块时,garden check 报 diff-orphan 错误。
- 能否复制新版
- 不能
完整代码 + 紧跟的 diff
两段合成一个代码框,可在「代码」和「对比上一版」之间切换。
- 能否复制新版
- 两个标签下都复制新版
```garden compare
items:
- title: 只贴一段 diff
text: 读者只看到增删行;前面没有完整代码块时,garden check 报 diff-orphan 错误。
能否复制新版: 不能
- title: 完整代码 + 紧跟的 diff
text: 两段合成一个代码框,可在「代码」和「对比上一版」之间切换。
能否复制新版: 两个标签下都复制新版
```
- 用:并排对比 2~3 种方案、配置方式或改动前后的行为差异时(每格文字控制在 60 字以内)。
- 别用:对比项超过 3 个或需要横向对齐多个参数维度时,直接用 Markdown 表格。
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
items | 是 | 数组(至少 2 项) | 对比项列表;每项也可简写为 "标题:说明" 单行字符串 |
items[].title | 建议 | 字符串 | 该对比列的标题 |
items[].text | 建议 | 字符串或字符串数组 | 该对比列的正文说明 |
items[].<自定义键> | 否 | 字符串或数字 | 除 title / text 外的附加键值会渲染在卡片底部的属性标签行 |