emailmd

emailmd

编写 Markdown。发送邮件。拒绝 HTMHELL。

emailmd 可将 Markdown 转换为响应式、适用于邮件的 HTML，兼容 Gmail、Outlook、Apple Mail、Yahoo 及其他所有客户端。

安装

npm install emailmd

快速入门

import { render } from "emailmd";

const { html, text } = await render(`
# Welcome!

Thanks for signing up.

[Get Started](https://example.com){button}
`);

// html → complete email-safe HTML
// text → plain text version for text/plain MIME part

v0.3.0 迁移说明： render() 现在是异步的。请将调用从 render(md) 更新为 await render(md)。需要 Node 20+（MJML 5）。

图表与数据

条形图、进度条、迷你趋势图、KPI 磁贴、步骤追踪器和星级评分，均可通过普通 Markdown 列表编写：

::: chart
- Spotify: 16,900
- Apple Podcasts: 12,400
- Web player: 6,200
- RSS: 2,900
:::

它们由表格单元格和文本字符绘制，而非图片或 SVG，因此即使客户端屏蔽远程图片，也能正常渲染；在纯文本部分中，它们也会重新绘制，而不是缩成数字列表。请参阅指令参考。

CLI

emailmd 还附带命令行界面。

# Render to HTML
emailmd input.md

# Write to file
emailmd input.md -o output.html

# Plain text output
emailmd input.md --text

# Pipe from another command
echo "# Hello" | emailmd

运行 emailmd --help 查看所有选项。

React

@emailmd/react 提供实时预览钩子（useEmailmd）、<EmailPreview /> iframe 组件，以及 <EmailmdBuilder />——可作为即插即用组件集成到你自己的应用中的完整构建器。

npm install @emailmd/react emailmd

了解更多

• 文档 — 完整的语法参考、主题、frontmatter、指令和 API
• 模板 — 可直接复制并自定义的现成邮件模板
• 构建器 — 可在浏览器中编写和预览邮件的实时编辑器

MCP

emailmd 附带一个 Model Context Protocol 服务，因此 AI 助手可以为你渲染、检查和预览邮件。它通过以下任一传输方式提供三个工具：render（将 Markdown 转换为适用于邮件的 HTML）、lint（标记送达性问题，无需渲染）和 read_docs（查询 emailmd 语法）：

# Hosted (Streamable HTTP)
https://www.emailmd.dev/api/mcp

# Or run it locally over stdio
npx emailmd mcp

该服务已作为 dev.emailmd/emailmd 发布到官方 MCP 注册表。有关各客户端的设置说明，请参阅 MCP 文档。

AI

更喜欢纯文本上下文而非工具？emailmd 就是 Markdown，因此 AI 很擅长编写模板。将完整文档提供给你的 AI 工具：

https://www.emailmd.dev/llms-full.txt

参与贡献

欢迎贡献！欢迎提交 issue 或 pull request。

emailmd 正在积极开发中。在达到 1.0 之前，API 可能会在次要版本之间发生变化——重大变更总会在变更日志中明确说明。关于语义化版本约定所涵盖的内容，请参阅稳定性与版本管理。

致谢

• 底层由 MJML 构建
• 由 Anypost 赞助

许可证

MIT