How mjmlio/mjml works
MJML is a markup language and compiler for responsive email HTML. The main workflow accepts MJML, parses it into a tree, validates and renders components, then returns or writes HTML; the CLI adds file, stream, watch, and output modes. The graph also preserves the standard component library and configuration/preset capabilities. Some subsystem links are documented or indexed imports; unsampled component and validator internals are represented at their existing package directories, without asserting unshown call paths.
Main entry points: client.js CLI orchestration · src/index.js HTML compiler · watchFiles.js Watch mode · src/index.js XML parser
Components 18
Inputs and CLI
- CLI orchestration
packages/mjml-cli/src/client.js - File input
packages/mjml-cli/src/commands/readFile.js - Watch mode
packages/mjml-cli/src/commands/watchFiles.js - Include tracking
packages/mjml-cli/src/helpers/fileContext.js - File output
packages/mjml-cli/src/commands/outputToFile.js - Console output
packages/mjml-cli/src/commands/outputToConsole.js - Stream input
packages/mjml-cli/src/commands/readStream.js
Parsing and rendering
- XML parser
packages/mjml-parser-xml/src/index.js - Tree cleanup
packages/mjml-parser-xml/src/helpers/cleanNode.js - HTML compiler
packages/mjml-core/src/index.js - Component runtime
packages/mjml-core/src/createComponent.js - Rendering helpers
packages/mjml-core/src/helpers
Email components
- Standard components
packages - Core preset
packages/mjml-preset-core/src
Validation and config
- MJML validator
packages/mjml-validator/src - MJML configuration
packages/mjml-core/src/helpers/mjmlconfig.js
Other components
- Template author
- Responsive HTML
Connections 26
- Template author → CLI orchestration: supplies input
README.md - Template author → HTML compiler: compiles with
README.md - CLI orchestration → File input: reads files
packages/mjml-cli/src/client.js - CLI orchestration → Stream input: reads stream
packages/mjml-cli/src/client.js - CLI orchestration → Watch mode: starts watch
packages/mjml-cli/src/client.js - Watch mode → File input: reads changes
packages/mjml-cli/src/commands/watchFiles.js - Watch mode → Include tracking: tracks includes
packages/mjml-cli/src/commands/watchFiles.js - Watch mode → HTML compiler: compiles changes
packages/mjml-cli/src/commands/watchFiles.js - Watch mode → File output: writes results
packages/mjml-cli/src/commands/watchFiles.js - CLI orchestration → XML parser: parses input
packages/mjml-cli/src/client.js - CLI orchestration → HTML compiler: renders input
packages/mjml-cli/src/client.js - CLI orchestration → MJML validator: validates input
packages/mjml-cli/src/client.js - CLI orchestration → Core preset: loads preset
packages/mjml-cli/src/client.js - CLI orchestration → File output: writes HTML
packages/mjml-cli/src/client.js - CLI orchestration → Console output: prints HTML
packages/mjml-cli/src/client.js - XML parser → Tree cleanup: cleans tree
packages/mjml-parser-xml/src/index.js - HTML compiler → Component runtime: uses runtime
packages/mjml-core/src/index.js - Component runtime → XML parser: parses fragments
packages/mjml-core/src/createComponent.js - Component runtime → Rendering helpers: formats output
packages/mjml-core/src/createComponent.js - HTML compiler → Rendering helpers: uses helpers
packages/mjml-core/src/index.js - XML parser → Responsive HTML: feeds rendering
- HTML compiler → Responsive HTML: produces HTML
README.md - Standard components → HTML compiler: rendered by
packages/mjml-core/src/index.js - Core preset → Standard components: registers components
- MJML validator → HTML compiler: checks MJML
- MJML configuration → HTML compiler: configures rendering
packages/mjml-core/src/index.js