GETTING STARTED / FIRST CONVERSION

完成第一次排版转换。

准备一段 Markdown 和有效的 API Key，选择熟悉的方式调用，再检查返回结果。

01 · 选择调用方式

CLI

npm install -g @geekjourneyx/md2wechat

md2wechat config init --json
md2wechat inspect article.md --json
md2wechat convert article.md --output article.html

示例需先配置 API Key。转换返回 HTML，不创建公众号草稿。

02 · 检查转换结果

成功时，响应包含可用的 HTML 和当前文章的主题、字号等信息。

响应结构示意

{
  "code": 0,
  "msg": "success",
  "data": {
    "html": "<section>文章排版内容</section>",
    "theme": "default",
    "fontSize": "medium"
  }
}

此处只展示部分响应字段。完整内容见 API 参考。

03 · 预览，再继续

查看标题、正文、引用和图片。需要修改时返回 Markdown；需要草稿时，再完成公众号配置。

查看主题效果查看完整 API 参考

转换后会直接发布到公众号吗？

不会。排版 API 返回公众号可用 HTML。创建草稿需要另行配置公众号，并通过明确的草稿操作完成。

必须安装 CLI 才能使用吗？

不必。你可以直接请求 API；CLI 为本地文件、检查和 Agent 工作流提供更方便的入口。

如何获取 API Key？