Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/freethinkingit/inline-email
A CLI for converting HTML files to inline styled HTML suitable for emails.
https://github.com/freethinkingit/inline-email
cli convert-html-files email-marketing email-template emails html inky inline inline-css inline-styles juice nodejs
Last synced: 8 days ago
JSON representation
A CLI for converting HTML files to inline styled HTML suitable for emails.
- Host: GitHub
- URL: https://github.com/freethinkingit/inline-email
- Owner: freethinkingit
- License: mit
- Created: 2018-01-19T02:52:29.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T11:49:50.000Z (almost 2 years ago)
- Last Synced: 2024-10-31T23:31:25.578Z (15 days ago)
- Topics: cli, convert-html-files, email-marketing, email-template, emails, html, inky, inline, inline-css, inline-styles, juice, nodejs
- Language: JavaScript
- Homepage: https://freethinking.it
- Size: 306 KB
- Stars: 16
- Watchers: 2
- Forks: 7
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.org/package/inline-email)
[](https://www.npmjs.com/package/inline-email)
[](https://www.npmjs.org/package/inline-email)
[](https://travis-ci.org/freethinkingit/inline-email)
[](https://david-dm.org/freethinkingit/inline-email)
# Inline Email - CLI
A CLI for converting HTML files to inline styled HTML suitable for emails.
The CLI also supports Inky HTML-based templating using `--inky` as an argument.
The CLI is designed to make working with ExactTarget, MailChimp, Emarsys, or any other email service easier if you're simply pasting the output into those systems.
You're your curious to [learn about the tool's history](https://github.com/freethinkingit/inline-email/wiki/1.-How-The-Tool-Came-to-Be) or [see an example usage](https://github.com/freethinkingit/inline-email/wiki/2.-Building-Templates-and-Blocks) checkout the [Wiki](https://github.com/freethinkingit/inline-email/wiki).
> `inline-email` relies heavily on [Inky](https://github.com/zurb/inky) and [Juice](https://github.com/Automattic/juice). The CLI itself is built on top of [command-line-args](https://github.com/75lb/command-line-args) and [command-line-usage](https://github.com/75lb/command-line-usage). Many thanks to the maintainers of those projects.
## Supported NodeJS Versions
Current 2.x version of `inline-email` are tested against NodeJS 8.x -> 11.x.
The 2.x will work on version 6.x and 8.x, but the test runners no longer support these so validation is not guaranteed.
Previous 1.x versions of `inline-email` support NodeJS 6.x -> 9.x. Older NodeJS will not work with this package.
## What this does not do.
`inline-email` does NOT check you're using email safe HTML tags.
It also won't replace any non-safe tags.
## Installation
```sh
npm install -g inline-email
```
## Usage
By default `inline-email` resolves `` and `` tags and inlines the styles found within after which it removes the `<link>` and `<style>` tags from the HTML. This process is done using [Juice](https://github.com/Automattic/juice). Currently not all of Juice's options can be passed through the CLI, though it will use the appropriate Juice function to handle your HTML input depending on if you provided css or not.
You can simple print the output to the console.
```sh
$ inline-email some.html
> your-html-to-stdout
```
Or you can send it to a file.
```sh
$ inline-email some.html --out inlined.html
```
If you wish to pass in a `.css` files (or files) on your own (if your HTML doesn't have `<link>` or `<style>` tags) you can. Note that if the file does have these tags they will be ignored and the passed in files will be used instead.
```sh
$ inline-email --css some.css --out inlined.html some.html
```
### Inky Usage
With `--inky` nothing changes, but the HTML file is pre-proccessed through [Inky](https://github.com/zurb/inky). All the other agruments operate exactly the same.
```sh
$ inline-email --inky inky.html
> your-slightly-different-inkyish-output
```
## Contributing with new features
Want to contribute? [Follow these recommendations](CONTRIBUTING.md).
## License
[MIT](LICENSE.md)
---------------------------
© 2018 Freethinking IT <[email protected]>