emailmd

emailmd

Markdown を書いて、メールを送信。HTMHELL は不要です。

emailmd は Markdown を、Gmail、Outlook、Apple Mail、Yahoo、その他すべてのクライアントで動作する、レスポンシブでメールに適した HTML に変換します。

インストール

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

詳細情報

• ドキュメント — 構文の完全なリファレンス、テーマ設定、フロントマター、ディレクティブ、API
• テンプレート — コピーしてカスタマイズできる、すぐに使えるメールテンプレート
• ビルダー — ブラウザーでメールを作成・プレビューできるライブエディター

MCP

emailmd にはModel Context Protocol サーバーが付属しており、AI アシスタントがメールのレンダリング、リント、プレビューを行えます。次の 3 つのツール（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

公式 MCP レジストリに dev.emailmd/emailmd として公開されています。クライアントごとの設定については、MCP ドキュメントをご覧ください。

AI

ツールよりも通常のコンテキストを使いたいですか？ emailmd は単なる Markdown なので、AI によるテンプレートの作成に適しています。ドキュメント全体を AI ツールに渡してください。

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

コントリビューション

コントリビューションを歓迎します！お気軽にイシューを作成するか、プルリクエストを送信してください。

emailmd は現在活発に開発中です。1.0 に到達するまでは、マイナーバージョン間で API が変更される可能性があります。破壊的変更は必ず変更履歴でお知らせします。semver 契約の対象については、安定性とバージョニングをご覧ください。

謝辞

• 内部ではMJMLを使用しています
• Anypostのスポンサーを受けています

ライセンス

MIT