如何在AsyncAPI 2.4.0/3.0.0的summary/description中添加表格？

要在AsyncAPI的summary或description字段中正确显示表格，你需要使用GitHub Flavored Markdown（GFM）标准表格语法，同时保证YAML的多行字符串格式配置正确，具体操作如下：

核心解决步骤 #

1. 替换ASCII手绘表格为GFM标准格式：用|分隔列，---分隔表头与内容行。
2. 表格前后需空出一行，与前面的文本内容分隔开，确保渲染器能识别为独立的表格块。
3. 保持YAML多行字符串的缩进一致性，避免格式错乱。

正确配置示例 #

summary: |
  Test summary description.

  | H1  | H2   |
  |-----|------|
  | ccc | ccc  |
  | ccc | ccc  |

原配置无效原因 #

你之前使用的ASCII手绘表格格式，多数AsyncAPI渲染工具（如官方AsyncAPI Studio）并不支持解析为表格，会被当作普通文本拼接显示。而GFM表格是AsyncAPI规范默认兼容的markdown语法，2.4.0和3.0.0版本均支持。

额外注意事项 #

• 确保summary/description使用YAML的|多行字符串标识，保留所有换行和格式。
• 表格的缩进需与前面的文本保持一致，不要额外增加过多缩进，否则可能被识别为嵌套内容导致解析失败。

内容的提问来源于stack exchange，提问作者Dinuka Kasun Medis