Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/disintegrator/grunt-juice-email
Inline stylesheets into email HTML templates using LearnBoost's Juice
https://github.com/disintegrator/grunt-juice-email
Last synced: 4 months ago
JSON representation
Inline stylesheets into email HTML templates using LearnBoost's Juice
- Host: GitHub
- URL: https://github.com/disintegrator/grunt-juice-email
- Owner: disintegrator
- License: mit
- Archived: true
- Created: 2013-08-16T05:26:01.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-02-21T03:16:43.000Z (almost 9 years ago)
- Last Synced: 2024-08-08T10:19:28.996Z (4 months ago)
- Language: JavaScript
- Size: 9.77 KB
- Stars: 16
- Watchers: 4
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-juice-email
> Inline stylesheets into email HTML templates using Automattic's Juice
## Getting Started
This plugin requires Grunt `~0.4.1`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-juice-email --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-juice-email');
```
## The "juice" task
### Overview
In your project's Gruntfile, add a section named `juice` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
juice: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
})
```
### Options
This task's options are the same as those passed to the juice function.
The available options can be found [here](https://github.com/Automattic/juice#juicefilepath-options-callback).
### Usage Examples
```js
grunt.initConfig({
juice: {
your_target: {
options: {},
files: {
'dest/email-template.html': 'src/email-template.html',
},
},
},
})
```
```js
grunt.initConfig({
juice: {
your_target: {
options: {},
files: [
{
src: 'src/email-template.html',
dest: 'dest/email-template.html'
},
],
},
},
})
```