项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 3786
使用教程
ℹ 本教程由 AI 依据该项目 README 整理,个别步骤可能需要按你的环境微调。
环境要求
- 已安装 Node.js 与 npm(项目通过 npm 全局安装)
- 可访问 npm 源以安装 @geekjourneyx/md2wechat
- md2wechat API Key(API 模式的预览与转换需要)
- 创建微信草稿还需微信凭证与 IP 白名单(见 docs/WECHAT-CREDENTIALS.md)
安装与启动步骤
-
1全局安装 CLI
用 npm 全局安装 md2wechat 命令行工具,安装完成后即可在终端直接调用 md2wechat 命令。
npm install -g @geekjourneyx/md2wechat -
2确认版本
执行版本命令确认安装成功,加 --json 便于脚本或 Agent 解析输出结果。
md2wechat version --json -
3初始化配置
生成配置文件骨架,后续填入 API Key 等凭证;具体配置项见 docs/CONFIG-WALKTHROUGH.md。
md2wechat config init --json -
4获取并填写 API Key
API 模式的预览和转换需要 md2wechat API Key,可在官网价格页获取专业 API 后写入配置。
-
5校验配置
检查凭证配置是否正确,校验通过后再执行后续转换,避免中途失败。
md2wechat config validate --json -
6检查文章
先检查 Markdown 的标题、摘要、图片与草稿就绪状态,此命令不会上传图片或创建草稿。
md2wechat inspect article.md --json -
7生成预览与 HTML
把排版结果写入本地文件,preview 用于预览、convert 生成最终 HTML,均为只读操作。
md2wechat preview article.md --output preview.html md2wechat convert article.md --output article.html -
8推送微信草稿
需要创建草稿时显式加 --draft 与 --cover;若用 --wechat-account,两条命令必须传同一账号名。
md2wechat inspect article.md --draft --cover cover.jpg --json md2wechat convert article.md --draft --cover cover.jpg
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
md2wechat API Key | 是 | API 模式预览与转换的凭证,通过 config init 生成后填写 | sk-xxxxxxxx |
wechat-account | 否 | 多账号场景下指定命名公众号账号,inspect 与 convert 必须一致 | my-account |
如何确认成功
运行 md2wechat version --json 能输出版本信息,且 md2wechat config validate --json 校验通过。
常见问题
Q:预览或转换时报错缺少凭证?
A:API 模式的预览和转换需要 md2wechat API Key。先执行 md2wechat config init --json 生成配置,再填入从官网获取的 API Key,并用 config validate 校验。
Q:为什么执行命令后公众号里没有草稿?
A:inspect、preview、convert 默认不会上传图片或创建草稿。需要草稿时必须在 inspect 和 convert 上显式加 --draft 与 --cover 参数。
Q:多账号发布要注意什么?
A:使用 --wechat-account 指定账号名时,inspect 和 convert 两条命令必须传入同一个账号名,否则目标不一致。还可本地只读发现账号,不会输出 Secret。
Q:商业使用是否免费?
A:项目采用 Source Available License,个人使用、学习、评估、非营利使用免费;商业使用、SaaS、客户交付、白标、再分发和训练数据用途需要商业授权。
注意事项
- 只读命令(inspect、preview、convert)不会上传图片或创建草稿,副作用操作需显式加 --draft。
- 使用 --wechat-account 时,inspect 与 convert 必须传同一个账号名。
- 安装方式、微信凭证与 IP 白名单、完整配置说明分别见 docs/INSTALL.md、docs/WECHAT-CREDENTIALS.md、docs/CONFIG-WALKTHROUGH.md。
- 商业使用、SaaS、白标、再分发和训练数据用途需商业授权,可联系 skrphper@gmail.com。
核心亮点
- 一键将 Markdown 转换为微信公众号排版,支持 40+ 样式和专业主题,显著提升排版效率
- 集成 AI 配图功能,自动为文章生成配图,减少手动找图成本
- 支持批量发布和多账号管理,适合内容团队或运营者高频发布场景
不足之处
- 文档/社区待观察
适用场景
- 技术博客作者快速排版发布到公众号
- 内容运营团队批量管理多个公众号并发布文章
- 需要统一风格排版且希望自动化配图的写作场景
替代项目
md2wechat、wechat-format、doocs/md
同类项目推荐
AI_paper
开源
从定题到初稿一站搞定,论文写作少熬夜
一站式AI学术论文写作辅助工具 · 支持从定题出稿全过程,涵盖降AIGC、查重率、润色、纠错···
denova
开源
写小说跑团,用 AI 智能体流水线一站式搞定
Your One-Stop AI Workbench for Novel Writing and Role-Playing.
anti-ai-slop-writing
开源
专治AI空洞话,每句都有干货
AI writing skill that eliminates detectable AI patterns. Works with Claude Code, Cod···
md2wechat-skill
开源
Markdown一键发公众号,排版配图全自动
面向 AI Agent 的微信公众号创作与发布 CLI:Markdown 排版、AI 配图、预览与草稿创建;支···
narralume
开源
把设定、改稿、AI 续写和审稿装进一个自托管写作台
Open-source AI-assisted writing studio for long-form fiction. 故事设定、正文版本、AI···
short-drama-factory
开源
一句创意或网文,批量生成带付费墙的百集短剧剧本
Short-Drama Factory v4.9.1 · 抖音/红果爆款短剧工业化编剧超级系统 | 一句创意/一部网文···
qu-ai-wei
开源
一键去AI味,文字马上接地气
去 AI 味:去除简体中文 AI 写作痕迹 / Chinese humanizer skill
socialpostgpt
开源
输入主题,一键生成带图社交媒体帖子
Uses magic to generate social media posts using Wasp, ChatGPT and stock photos APIs
kunpeng
开源
本地跑的中文 AI 写作台,素材不出电脑
鲲鹏 Kunpeng — 跑在本地的中文 AIGC 创作工作台(Tauri + React + Rust,内嵌 DeepSeek ···