Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ertrzyiks/grunt-email-templates
Grunt task for email templates lib
https://github.com/ertrzyiks/grunt-email-templates
Last synced: about 1 month ago
JSON representation
Grunt task for email templates lib
- Host: GitHub
- URL: https://github.com/ertrzyiks/grunt-email-templates
- Owner: ertrzyiks
- License: mit
- Created: 2014-09-30T17:57:23.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-04-02T21:17:17.000Z (almost 10 years ago)
- Last Synced: 2024-12-07T19:35:58.755Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 288 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-email-templates [](https://travis-ci.org/ertrzyiks/grunt-email-templates)
> Email templates task
## Getting Started
This plugin requires Grunt `~0.4.5`.
This task is encapsulation of [node-email-templates](https://github.com/niftylettuce/node-email-templates).
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-email-templates --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-email-templates');
```
## The "email_templates" task
### Overview
In your project's Gruntfile, add a section named `email_templates` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
email_templates: {
your_target: {
// Target-specific file lists and/or options go here.
'target/folder': 'source/folder'
},
},
});
```
### Options
#### htmlFileName
Type: `String`
Default: `html.html`
Name of output file with html content.
#### txtFileName
Type: `String`
Default: `text.txt`
Name of output file with text content.
#### locals
Type: `Object`
Default: `{}`
Object with the variables used inside the templates.
### Usage Examples
#### Default Options
In this example, the default options are used. Template from *source/folder* will be handled by emails-template and saved
in *target/folder* with file names html.html and text.txt.
```js
grunt.initConfig({
email_templates: {
files: {
'target/folder': 'source/folder'
},
},
});
```
#### Custom filenames
Template from *source/folder* will be handled by emails-template and saved in *target/folder* with file names index.html and text.txt. Data inside the `locals` object will also interpolate within the template (eg. `<%= name %>` into *Bobby*).
```js
grunt.initConfig({
email_templates: {
options: {
htmlFileName: 'index.html',
locals: {
name: 'Bobby'
}
},
files: {
'target/folder': 'source/folder'
},
},
});
```
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
## Changelog
### 0.2.0
* added local options (thanks [@dannytranlx](https://github.com/dannytranlx))
### 0.1.1
* added options for name of files
### 0.1.0
* initial release