How Nodemailer MJML i18next Compiler prepared their website for AI search
This file points LLMs to concise, high-signal references for using the library. Core flow: Handlebars renders data and translations into MJML; MJML compiles ...
This implementation of the Nodemailer MJML i18next Compiler showcases how to effectively combine MJML templates with Handlebars and i18next for dynamic email generation. Readers will gain insights into template resolution strategies, internationalization practices, and the overall flow of compiling responsive HTML emails that adapt to user locales.
56
Lines
-95% vs avg
7
Sections
-59% vs avg
1000+
Companies
using llms.txt
2
Files
llms.txt + full
Key Insights
Focused approach
A streamlined 7-section structure keeps things simple and scannable.
Optimal length
At 56 lines, this file balances detail with AI context window efficiency.
Two-file approach
Uses both llms.txt and llms-full.txt for different AI use cases.
llms.txt Preview
First 56 lines of 56 total
# Nodemailer MJML i18next Compiler
> Nodemailer compile plugin that renders MJML templates with Handlebars and i18next translations to produce responsive HTML emails from MJML.
This file points LLMs to concise, high-signal references for using the library. Core flow: Handlebars renders data and translations into MJML; MJML compiles to responsive HTML; the Nodemailer compile plugin assigns the result to `mail.data.html` and resolves a translated subject when configured. Templates are resolved by trying `<name>.mjml.hbs`, `.hbs.mjml`, `.mjml`, then `.hbs`. i18n defaults to filesystem-backed `i18next` loading from `locales/<lng>/<ns>.json`. Use `{{t "ns:key"}}` or `{{__ "ns:key"}}` in templates; locale comes from `mail.data.locale`.
Important notes:
- The plugin runs in Nodemailer’s compile phase (`transporter.use('compile', ...)`).
- `strict` throws on MJML errors; otherwise errors are exposed at `mail.data.mjmlErrors`.
- Subjects: set `mail.data.subject`, or use `mail.data.subjectKey`, or enable `autoSubject` (default) to use `<subjectNamespace>:<template>.subject`.
- Security: avoid untrusted helpers/partials; pin `templatesDir`, `partialsDir`, and `localesDir` paths.
## Docs
- [Overview](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/docs/index.md): What the plugin does and a quick start.
- [Usage](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/docs/usage.md): Templates, helpers, i18n, and mail data fields.
- [Options](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/docs/options.md): Full `mjmlI18nextCompiler` configuration.
- [Changelog (docs)](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/docs/changelog.md): Release notes on the docs site.
## API & Source
- [Runtime entry (`src/index.js`)](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/src/index.js): Compiler implementation, template resolution, helpers, and subject logic.
- [Types (`src/index.d.ts`)](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/src/index.d.ts): TypeScript declarations including `MjmlI18nextOptions`.
## Getting Started
- [README](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/README.md): Install, usage example, template format, and notes.
- [Example sender (`example/send.js`)](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/example/send.js): Minimal demo using the plugin.
## Example Assets
- [Template: `welcome.mjml.hbs`](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/example/templates/welcome.mjml.hbs): Example MJML + Handlebars template.
- [Partial: `partials/footer.mjml.hbs`](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/example/templates/partials/footer.mjml.hbs): Example Handlebars partial.
- [Locales: `en/emails.json`](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/example/locales/en/emails.json): Subject/title strings.
- [Locales: `en/common.json`](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/example/locales/en/common.json): Shared strings.
## Scripts
- [Smoke test (`scripts/smoke.js`)](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/scripts/smoke.js): Basic compile + subject validation against the example.
## Project Metadata
- [CHANGELOG.md](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/CHANGELOG.md): Versioned changes.
- [LICENSE](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/LICENSE): MIT license.
- [AUTHORS](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/AUTHORS): Project authors.
- [mkdocs.yml](https://github.com/xjodoin/nodemailer-mjml-i18next-compiler/blob/main/mkdocs.yml): Docs site configuration.
## Optional
- [Nodemailer plugin docs](https://nodemailer.com/usage/plugins/): How compile plugins integrate in Nodemailer.
- [MJML documentation](https://documentation.mjml.io/): MJML components and options.
- [Handlebars guide](https://handlebarsjs.com/guide/): Templates, helpers, and partials.
- [i18next core](https://www.i18next.com/): i18n concepts and usage.
- [i18next-fs-backend](https://github.com/i18next/i18next-fs-backend): Filesystem backend used when no custom i18next instance is provided.
Nodemailer MJML i18next Compiler is set up. Is yours?
Check your AI readiness in 30 seconds. See who AI recommends in your space. Free, no signup.
1000+ sites already set up
Nodemailer MJML i18next Compiler is ready for AI. Are you?
Check your AI readiness score in 30 seconds — free, no signup required. Then generate your own llms.txt and start tracking your visibility.