md2wechat Agent API markAgent API 文档
md2wechat Agent API markAgent API 文档
首页

开始

Markdown 转微信公众号 API 文档QuickstartAuth

接口

API OverviewThemeConvertAdvanced LayoutMode SelectionAdvanced Layout Use CasesAdvanced Layout SyntaxAdvanced Layout MistakesDiscovery-First Workflowdoctor 与 inspect 准备状态Advanced Layout RecipesArticle DraftNewspic DraftBatch Upload

接入

运维

ErrorsPricingContact
X (Twitter)
API

Convert

把 Markdown 转成微信可粘贴 HTML。

Convert

What it does

把 Markdown 转成微信可粘贴 HTML。

Required headers

Content-Type: application/json
Md2wechat-API-Key: wme_your_api_key

Request body

{
  "markdown": "# 标题\n\n正文",
  "theme": "default",
  "fontSize": "medium",
  "convertVersion": "v1"
}

高级排版也走这个接口

如果你不只是想把 Markdown 转成 HTML,还想把结构一起带进去,那还是走同一个 convert。

区别在 markdown 字段里。普通正文照常写,高级排版的部分按模块语法写进去。

第一次接的话,可以先用这段:

{
  "markdown": ":::hero\ntitle: 这篇值不值得读,第一屏就该说清楚\nsubtitle: 高级排版模块的任务不是把文章弄花,而是把判断、节奏和行动收拢到一起\ntags: 排版 | 模块 | 公众号\n:::\n\n:::cards[这篇会讲什么]\n判断 | 先讲值不值得看 | 不让读者滑了半天还不知道重点 | accent\n阅读 | 先让手机阅读不累 | 信息分层比堆样式更重要 | default\n转化 | 最后把动作收清楚 | 收藏、关注、咨询都要有落点 | default\n:::\n\n## 正文\n\n这里继续写普通 Markdown 正文。",
  "theme": "default",
  "fontSize": "medium",
  "convertVersion": "v1"
}

什么时候该用高级排版

更适合这些内容:

  • 发布稿:要先把新东西讲清楚
  • 教程稿:要让手机窄屏里不累
  • 方案稿:要让读者记住判断和差异
  • 服务稿:要把信任和行动收在一起

如果你只是发一条很短的消息,普通 Markdown 通常就够了。

Theme parameter

  • theme 必须使用当前公开支持的主题 id
  • 全量主题列表见 /themes
  • 选型原则和接入说明见 Theme

相关文档

  • Features
  • Mode Selection
  • Advanced Layout
  • Advanced Layout Use Cases
  • Advanced Layout Syntax
  • Advanced Layout Mistakes
  • Advanced Layout Recipes
  • Discovery-First Workflow

Copy-paste curl

curl -X POST "https://md2wechat.com/api/v1/convert" \
  -H "Content-Type: application/json" \
  -H "Md2wechat-API-Key: wme_your_api_key" \
  -d '{
    "markdown": "# 标题\n\n正文",
    "theme": "default",
    "fontSize": "medium",
    "convertVersion": "v1"
  }'

Success response

返回微信可粘贴 HTML。

Failure response

常见失败包括认证错误或 Markdown 参数不合法。

Agent notes

  • 这是最适合第一次接入的接口。
  • 只需要 HTML 输出的工作流优先用它。
  • 如果你要接高级排版,别一上来堆很多模块,先看 Advanced Layout Recipes

Theme

说明 `theme` 参数如何映射到 md2wechat 的主题目录和编辑器主题画廊。

Advanced Layout

这页先讲高级排版模块到底在处理什么问题,再讲什么时候该用、什么时候不必用,以及第一次接入该从哪几页开始看。

目录

Convert
What it does
Required headers
Request body
高级排版也走这个接口
什么时候该用高级排版
Theme parameter
相关文档
Copy-paste curl
Success response
Failure response
Agent notes