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/CrocoCode-co/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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file inkletter-1.0.0.tar.gz.
File metadata
- Download URL: inkletter-1.0.0.tar.gz
- Upload date:
- Size: 15.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b7c47d8d36002d9a5feb860f174cf8ae3c527f09ff332869afcdb187682ed850
|
|
| MD5 |
7310efcd61f8a076fbd9441305a4a645
|
|
| BLAKE2b-256 |
bac87a4882ed4d421ac809e36e8d61231bce474dbfd8257e55d753b27f09e30e
|
File details
Details for the file inkletter-1.0.0-py3-none-any.whl.
File metadata
- Download URL: inkletter-1.0.0-py3-none-any.whl
- Upload date:
- Size: 16.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d5c674011b8553b8d9276e88e89966ae4290bde14a2cee96cfc2f78212f983ca
|
|
| MD5 |
bd8c2751e65907a36d2d1ba8dd48a404
|
|
| BLAKE2b-256 |
d127ae39c657b98108473634c35925a4914c353c2a1e1aab2e1aea94732ada6a
|