{"id":19935019,"url":"https://github.com/nickersoft/maildown","last_synced_at":"2025-05-03T12:30:53.666Z","repository":{"id":65088891,"uuid":"581674775","full_name":"Nickersoft/maildown","owner":"Nickersoft","description":"Write transactional and marketing emails with MJML \u0026 Markdown 📨","archived":false,"fork":false,"pushed_at":"2025-04-27T03:53:21.000Z","size":140,"stargazers_count":3,"open_issues_count":11,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-27T04:29:10.746Z","etag":null,"topics":["cli","email","javascript","markdown","marketing","mjml","transactional","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Nickersoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-12-23T23:03:23.000Z","updated_at":"2024-04-22T16:26:51.000Z","dependencies_parsed_at":"2023-12-08T12:30:45.118Z","dependency_job_id":"552aef10-c0b8-4ddf-ac6a-faba69c8001d","html_url":"https://github.com/Nickersoft/maildown","commit_stats":null,"previous_names":["nickersoft/maildown","linguistic/maildown"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nickersoft%2Fmaildown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nickersoft%2Fmaildown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nickersoft%2Fmaildown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nickersoft%2Fmaildown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nickersoft","download_url":"https://codeload.github.com/Nickersoft/maildown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251879117,"owners_count":21658690,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","email","javascript","markdown","marketing","mjml","transactional","typescript"],"created_at":"2024-11-12T23:18:27.914Z","updated_at":"2025-05-03T12:30:53.292Z","avatar_url":"https://github.com/Nickersoft.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 💌 MailDown\n\nMailDown is (very much an alpha) CLI tool for writing transactional and marketing emails using [markdown](https://daringfireball.net/projects/markdown/).\n\nMM comes with a slew of impressive features, such as:\n\n📱 **Responsiveness by default**: MailDown uses [MJML](https://mjml.io) under-the-hood for its styling, layout engine and transpiler, so you can be assured that your emails will look beautiful on every device.\n\n🔁 **Variable interpolation**: Using the incredibly-fast [ETA](https://eta.js.org/) templating language, MailDown allows you to inject variables into your email templates.\n\n🌍 **Localization support**: MailDown expects each email directory to contain a collection of locale directories, so you can write the same email in as many languages as you wish!\n\n🙏🏻 **No runtime overhead**: MailDown compiles your email templates to regular JavaScript functions, so there's no need to read HTML files from the filesystem or compile MJML.\n\n## How to use\n\nUsing MailDown is dead-simple. First install the CLI:\n\n```bash\n$ npm install -g maildown\n```\n\nThen, set up a project similar to the following:\n\n```\nemails/\n  en/\n    hello-world.email.md\n```\n\nWhere `hello-world.email.md` might look something like:\n\n```markdown\n# Hello world!\n\nHey {{ name }},\n\nThis is a test email!\n```\n\nThen, in your root directory, run:\n\n```\n$ maildown generate\n```\n\nwhich will produce an `index.js` file inside the `emails` directory.\n\nYou can then use your email templates as follows:\n\n```js\nimport { helloWorld } from './emails';\n\nconsole.log(helloWorld.en.html({ name: 'John Doe' }));\n```\n\nYou can check out the [example](./example) folder for more details!\n\n## Why would I need this?\n\nWith the plethora of high-end email suites like [SendGrid](https://sendgrid.com) and [MailChimp](https://mailchimp.com), it might be inconceivable why you want (or need) a library like this. There are a few reasons we decided to build this library, so let's look at them:\n\n- **Money:** As your company grows, tools like SendGrid and MailChimp only become more and more expensive. Cheaper alternatives, such as [AWS SES](https://aws.amazon.com/ses/) don't feature snazzy template builders and expect you to bring your own HTML. That's where MailDown comes in.\n- **Control:** Keeping all your email templates inside a SaaS product limits the portability of those templates if you decide to move to a different provider in the future. MailDown allows you to keep your email templates checked-in to version control, so you can send them using any provider.\n- **Customization:** By giving developers full control over their email's styling, HTML, and content, they have the ability to bypass any restrictions imposed by a SaaS product.\n\n## A word to the wise\n\nConsidering MailDown allows you to bypass needing to rely on a SaaS product for your emails, **it will be your responsibility to implement contact management and unsubscribe links.** This is crucial, as not providing a way for users to unsubscribe from emails may break anti-spam laws.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickersoft%2Fmaildown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnickersoft%2Fmaildown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickersoft%2Fmaildown/lists"}