md2wechat-guide

md2wechat Guide

把 Markdown 变成适合微信公众号阅读的 HTML，并在你明确确认后创建公众号草稿。这套指南按实际任务组织，第一次使用可以直接从“快速开始”走完整个预览流程。

你想完成什么

目标	从这里开始
安装并生成第一份 HTML	快速开始
选择主题或高级排版	主题与样式、高级排版
让办公 Agent 安装并使用 md2wechat	复制安装与排版提示词
接入 Markdown 转换接口	Convert API
上传素材或创建公众号草稿	发布到微信公众号
保存到知乎、CSDN、头条、腾讯云开发者社区未发布草稿	多平台草稿
排查安装、配置和预览问题	常见问题

第一次预览

先按安装与升级完成安装，并准备 Convert API 使用的 MD2WECHAT_API_KEY。下面的值只是占位符，请替换为自己的 Key：

npm install -g @geekjourneyx/md2wechat
md2wechat version --json
md2wechat capabilities --json
md2wechat skills read md2wechat --json
md2wechat config init
export MD2WECHAT_API_KEY="replace_with_your_key"
md2wechat doctor --json
md2wechat inspect article.md --json
md2wechat themes list --json
md2wechat themes show default --json
md2wechat preview article.md --theme default -o article.preview.html

preview 只有在 API 转换成功后才写入最终 HTML。AI 模式需要宿主 Agent 接手，转换失败时也不会新建或覆盖输出文件。

全部指南

1. 快速开始
2. 安装与升级
3. 主题与样式
4. 高级排版
5. AI 图片
6. Convert API
7. 常见问题
8. 从旧版迁移
9. Agent 与 Skill
10. 发布到微信公众号
11. 多平台草稿

当前版本与资料来源

当前稳定版本为 v3.8.0（2026-09-24）。本版扩展 cover-reveal、expand、刊头变体和品牌符号；输出仍以静态内容为准，微信内点击交互尚未验证。

本指南的排版能力基线源于 v3.8.0（提交 fce5fa3b4494fded0bdb942d50d17485281055d6），该版本提供 48 个 API 主题、83 个推荐使用场景、59 个推荐排版语法名和 65 项渲染层语法能力；这些数字代表不同维度，不能相互替换。

Windows PowerShell 使用 $env:MD2WECHAT_API_KEY = "replace_with_your_key"。不要把真实 Key 写进文章、截图或仓库。

命令细节以已安装版本的 --help 和发现命令为准。当前能力见 v3.8.0 Release、排版文档与写作指引；平台接入进度见 Wiki 平台证据（固定提交）。

发现错误时，请提交 Issue，附上版本、完整命令和脱敏后的错误信息。