geekjourneyx/obsidian-md2wechat

MD2WeChat Publisher – What It Is

MD2WeChat Publisher is an Obsidian desktop plugin that lets you write a markdown article in Obsidian, ask an AI‑enabled Agent (e.g., Claude, Codex, WorkBuddy) to format it for WeChat, preview the result side‑by‑side, and then push the formatted content as a draft to a WeChat public‑account.

The heavy‑lifting – markdown‑to‑WeChat HTML conversion, image uploading, and draft creation – is performed by the separate md2wechat CLI tool (installed globally via npm). The plugin itself only provides the UI inside Obsidian and the glue code that talks to the Agent and the md2wechat skill.

---

Core Capabilities

Capability	How It Works
Write & preview together	Opens a “公众号排版” panel next to the note. After the Agent finishes formatting, the preview shows the exact layout that will be sent to WeChat.
Agent‑agnostic	The plugin does not ship its own AI service. Any local Agent that supports the standard obsidian-md2wechat skill (Claude Code, Codex, WorkBuddy, ZCode, etc.) can be used.
Confirm before publishing	You choose the target public account, cover image, title, author, and summary. Only after you click Create Draft does the plugin invoke md2wechat to actually create the draft on WeChat.
Version‑aware drafts	The plugin records which article, account, and version have already been sent, so you can see past drafts and avoid duplicate submissions.
Live refresh	After editing the source markdown, clicking Refresh Layout re‑runs the Agent with the same theme/font settings, updating the preview without creating a new draft.

---

Installation Flow (as described in the README)

1. Install the md2wechat CLI

   npm install -g @geekjourneyx/md2wechat
   md2wechat version --json
   md2wechat config init --json   # run the wizard
   md2wechat config validate --json
   

   The CLI must be at least version 3.5.0.
2. Add the Obsidian plugin
   • Download the zip from the latest GitHub release (not the source archive).
   • Unzip and place the md2wechat‑publisher folder into <vault>/.obsidian/plugins/.
   • Restart Obsidian and enable MD2WeChat Publisher in Settings → Third‑party plugins.
3. Connect an Agent
   • Enable Obsidian’s official command‑line feature.
   • Copy the skills/obsidian-md2wechat directory from the plugin package into the Agent’s skill folder.
   • Ensure the Agent can execute the md2wechat skill (it will call the CLI under the hood).

---

Typical Workflow

1. Open a markdown note you want to publish.
2. Open the 公众号排版 side panel.
3. Speak (or type) to the Agent: “排版 Obsidian 当前文章，完成后展示给我。” – the Agent runs the md2wechat skill, converts the markdown, uploads any images, and returns a preview.
4. Adjust theme or font size via the panel’s More menu; copy the formatted HTML if needed.
5. When satisfied, click Create Draft, pick the WeChat account and cover image, confirm the metadata, and the plugin calls md2wechat to create the draft in the WeChat backend.
6. The panel now shows a record of the draft (account, timestamp, version). You can later refresh or re‑format the article without creating duplicates.

---

Compatibility & Limitations

• Supported OS – Tested on macOS; Windows/Linux not yet verified.
• Obsidian version – Desktop 1.12.7+ required; mobile client unsupported.
• Agent requirements – Must support local command execution and the obsidian-md2wechat skill. The plugin does not bundle any specific Agent.
• No API keys in the plugin – All credentials are managed by the md2wechat CLI configuration.

---

Development & Contribution

• Build with npm ci, lint with npm run check, and package via npm run package (requires the md2wechat CLI locally).
• Releases are automated: pushing a tag (e.g., v2.0.0) triggers GitHub Actions that produce the zip and upload it to the release page.
• Contributions follow the project’s AGPL‑3.0‑only license and the guidelines in dev.md, RELEASE.md, and AGENTS.md.

---

TL;DR

MD2WeChat Publisher is a bridge between Obsidian, an AI Agent, and the WeChat public‑account publishing pipeline. Write in markdown, let your local Agent format it, preview inside Obsidian, and, after a manual confirmation step, push the result as a WeChat draft—all without exposing API keys in the plugin itself.