关键信息
- 分类
- 转换与编码
- 输入类型
- textarea, checkbox
- 输出类型
- json
- 样本覆盖
- 4
- 支持 API
- Yes
概览
Markdown 转 Slack mrkdwn 工具能够快速将 GitHub 风格的 Markdown 文本转换为 Slack 兼容的 mrkdwn 格式。它不仅能自动重写标题、粗体、列表、链接和代码块,还能智能识别并标注出 Slack 不支持的元素(如表格、任务列表和图片),帮助您无缝地在 Slack 频道中发布排版精美的消息。
适用场景
- •需要将 GitHub 上的 Release Notes 或 Changelog 快速同步发布到 Slack 团队频道时。
- •在编写 Slack 机器人(Bot)或 Webhook 推送消息的文本模板,需要确保格式兼容时。
- •转换包含复杂 Markdown 格式的文档,并需要快速找出哪些元素(如表格、任务列表)在 Slack 中无法直接渲染时。
工作原理
- •在输入框中粘贴您编写的 GitHub 风格 Markdown 文本。
- •根据需要勾选“标注不支持的元素”选项,以便自动检测 Slack 无法直接渲染的格式。
- •工具将解析 Markdown 语法,将其转换为 Slack 的 mrkdwn 语法(例如将标题转为粗体,将无序列表转为圆点列表)。
- •实时输出转换后的 mrkdwn 文本以及未受支持元素的提示列表,方便您进行手动调整。
使用场景
用户案例
1. 转换 GitHub 发布日志至 Slack
运维工程师- 背景原因
- 每次项目发布时,GitHub 会自动生成 Markdown 格式的 Release Notes,需要同步发送到 Slack 的 #announcements 频道。
- 解决问题
- 直接复制 Markdown 会导致 Slack 格式错乱,特别是标题和任务列表无法正常显示。
- 如何使用
- 将 Release Notes 的 Markdown 文本粘贴到输入框中,勾选“标注不支持的元素”,点击转换。
- 示例配置
-
输入包含标题和任务列表的 Markdown 文本,并开启 annotateUnsupported 选项。 - 效果
- 获得转换后的 mrkdwn 文本,标题自动转为粗体,任务列表被标记为不支持的元素,方便快速手动微调后发送。
2. 编写 Slack 机器人推送模板
后端开发人员- 背景原因
- 正在开发一个监控报警机器人,需要将 Markdown 格式的系统告警信息转换为 Slack 兼容的格式进行推送。
- 解决问题
- 告警信息中包含代码块和链接,需要确保在 Slack 中能正确高亮和跳转。
- 如何使用
- 将告警 Markdown 模板输入工具,开启标注选项,获取转换后的 mrkdwn 字符串。
- 示例配置
-
输入包含代码块和超链接的 Markdown 文本。 - 效果
- 得到符合 Slack 规范的 mrkdwn 文本,代码块和链接均能完美兼容渲染。
用 Samples 测试
markdown相关专题
常见问题
为什么 Markdown 中的标题(#)转换后变成了粗体?
因为 Slack 的 mrkdwn 语法不支持标准的 HTML 标题,通常使用粗体(*文本*)来模拟标题效果。
转换器如何处理 Slack 不支持的表格或任务列表?
开启“标注不支持的元素”后,工具会在输出的 JSON 结果中列出这些元素(如 task-list),提示您需要手动调整。
链接和图片在转换后会怎样处理?
标准链接会被转换为 Slack 的 <URL|文本> 格式,而 Slack 不支持直接内联渲染 Markdown 图片,工具会将其标记为不支持的元素。
这个工具支持转换哪些 Markdown 语法?
支持标题、粗体、斜体、无序列表、行内代码、代码块以及标准超链接的转换。
转换结果为什么是 JSON 格式?
结果以 JSON 格式输出,以便同时返回转换后的 mrkdwn 文本和不支持的元素列表,方便程序调用或手动复制。