Skip to main content

Markdown to MJML/HTML converter and previewer

Project description

Inkletter

Write your emails like prose, send them like a pro.

Inkletter is a magical little tool that transforms your plain Markdown files into beautiful, responsive MJML and HTML email layouts, ready to be previewed, shared or sent to the world.

Why Inkletter?

Because writing HTML emails by hand is like ironing socks: pointless and painful.

With Inkletter, you write your content in Markdown (like a decent human being), and we turn it into gorgeous, mobile-friendly HTML emails powered by MJML.

Built with care, clarity and just enough elegance, the kind that pairs well with good typography and strong espresso.

Features

  • ✅ Convert Markdown to MJML
  • ✅ Convert Markdown to full responsive HTML
  • ✅ Live preview in your browser
  • ✅ Device simulator (iPhone, iPad, Desktop, etc.)
  • ✅ One command, zero headache
  • ✅ No vendor lock-in, fully offline

✨ Live Samples

Explore the included examples to see Inkletter in action:

  • 🔍 sample.md — the original Markdown source
  • 💎 sample.html — the final responsive HTML output
  • 🎨 preview.html — the interactive split preview (Markdown / MJML / Rendered)

Installation

Make sure you have Python 3.8+ installed on your system.

Then in your terminal:

pip install inkletter

Or for development:

git clone https://github.com/your-name/inkletter.git
cd inkletter
pip install -e .

How it works

1. Preview your Markdown as a responsive email

inkletter preview yourfile.md

This opens a split view in your browser with:

  • Your original Markdown
  • The generated MJML
  • A live rendered email with responsive device preview

Yes, even iPhone 14. You’re welcome.

2. Convert and export to HTML

inkletter md2mjml input.md -o output.html –view

This will:

  • Convert the Markdown to MJML
  • Render it into clean HTML
  • Save the HTML to output.html
  • Optionally open it in your browser with –view

No fuss. No noise. Just results.

Contributing

French or not, you are welcome to contribute. Fork it, branch it, test it, PR it — with love.

License

MIT — but don’t forget to say “merci” 😉

Made with ❤️ and markdown in France.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

inkletter-0.1.0.tar.gz (13.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

inkletter-0.1.0-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file inkletter-0.1.0.tar.gz.

File metadata

  • Download URL: inkletter-0.1.0.tar.gz
  • Upload date:
  • Size: 13.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for inkletter-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8423a89bd0b007709f8162eceddd99e4f80f520d58a14280f24ac8ec88a4dbcf
MD5 dcba8fbe3e756d5a33b31884271e368e
BLAKE2b-256 8d59a13d704a79a310e32d07f531a0b853e739d143378f032766805435bc9e8b

See more details on using hashes here.

File details

Details for the file inkletter-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: inkletter-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for inkletter-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8693c80678f31881a53acac512a04aca55d48d7cf1aa9bff40c86c8d62b12812
MD5 a916eccade19b547aab40b062d3edb69
BLAKE2b-256 89669fd2039f3763c648121950df742ec709cbccc6cb764b8d2c36092c2fe582

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page