Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rsslove/rss-to-email
Generate HTML emails from your RSS feeds.
https://github.com/rsslove/rss-to-email
email-template html html-emails mjml nodejs rss
Last synced: 17 days ago
JSON representation
Generate HTML emails from your RSS feeds.
- Host: GitHub
- URL: https://github.com/rsslove/rss-to-email
- Owner: rsslove
- Created: 2018-03-29T19:10:08.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-07-07T23:18:04.000Z (over 3 years ago)
- Last Synced: 2024-10-17T12:39:38.677Z (27 days ago)
- Topics: email-template, html, html-emails, mjml, nodejs, rss
- Language: JavaScript
- Homepage:
- Size: 10.9 MB
- Stars: 94
- Watchers: 4
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
Awesome Lists containing this project
README
# rss-to-email
Generate HTML emails and [mjml](https://mjml.io/) templates from one or more RSS feeds.
> Note: This project is pre-version 1.0.0, so breaking changes may occur. Use at your own risk or lock down to a specific version using NPM.
[](https://github.com/rsslove/rss-to-email/actions)
[](https://codecov.io/gh/rsslove/rss-to-email)
[](https://www.npmjs.com/package/rss-to-email)
[](https://github.com/portable-cto/rss-to-email)
[](https://opensource.org/licenses/Apache-2.0)
```
_ _ _
_ __ ___ ___ | |_ ___ ___ _ __ ___ __ _(_) |
| '__/ __/ __|_____| __/ _ \ _____ / _ \ '_ ` _ \ / _` | | |
| | \__ \__ \_____| || (_) |_____| __/ | | | | | (_| | | |
|_| |___/___/ \__\___/ \___|_| |_| |_|\__,_|_|_|
```
[](http://g.recordit.co/KKSAZBRdsT.gif)
## Table of Contents
- [Usage](#usage)
- [Node](#node)
- [Command Line](#command-line)
- [Browser](#browser)
- [Configuration](#configuration)
- [Templates](#templates)
- [Contributing](#contributing)
- [License](#license)
## Usage
### Node
The recommended way to use this package is as [an npm package](https://www.npmjs.com/package/rss-to-email). To install and save it to your project's dependencies, run:
```
npm install rss-to-email --save
```
After installing, call the `RssToEmail` factory with [a config object](#configuration). Use the resulting `rssToEmail` object to get emails in `mjml` or `html` formats:
```
const RssToEmail = require('rss-to-email');
const config = {
// See #Configuration section of the docs below
};
const rssToEmail = RssToEmail(config);
rssToEmail.getEmail('html').then((email) => {
console.log(email); // The HTML version of your email
});
rssToEmail.getEmail('mjml').then((email) => {
console.log(email); // The MJML version of your email
});
```
### Command Line
You can install this package globally and run it as a command line tool as well. First install it:
```
npm install -g rss-to-email
```
Then run the tool:
```
rss-to-email
```
The path should be relative to your current directory. For example, if your config file is at `./config.json` and you want to output the resulting files to a directory `./output`, you would run:
```
rss-to-email ./config.json ./output
```
### Configuration
For an example config file, see `config.example.json`.
- `accentColor`: A hex or html-safe color code.
- `filename`: The base name of the output files to generate (do not include extensions).
- `header`: Configuration for the header section of the email:
- `banner`: (optional) An image url for the banner at the top of the email.
- `link`: A link for the header image or text.
- `title`: Shown if the banner is not set or as an `alt` tag on the image.
- `intro`: The first line of the email. Can use HTML or plain text.
- `feeds`: An array of RSS feeds you'd like to include. Only `url` is required:
- `url`: The url to the RSS feed.
- `title`: (optional) A custom feed title. Will use the RSS feed's embedded one by default.
- `description`: (optional) A short custom feed description. Will use the RSS feed's embedded one by default.
- `limit`: (optional) Truncate items greater than a given limit.
- `publishedSince`: (optional) Filter out posts published before this date.
- `parserOptions`: (optional) Custom RSS parser options outlined in the Node [rss-parser](https://www.npmjs.com/package/rss-parser#xml-options) documentation.
- `outro`: The last line of the email. Can use HTML or plain text.
- `templateUrl`: (optional) A handlebars/mjml template. For more details, see [Templates](#templates) section.
### Templates
In order to compose custom emails, you can build your own [MJML templates](https://mjml.io/) with [Handlebars](). If you don't specify a template URL, the library defaults to [this file](https://raw.githubusercontent.com/portable-cto/rss-to-email/master/src/templates/default.mjml).
Many of the config file's variables are exposed in the templates including:
- `header`
- `intro`
- `outro`
The `feeds` variable contains an array of all of the feeds with an array of all of the items in each. For example, the following is a basic template that will loop through all the RSS feeds and items, displaying the title and content of each:
```html
{{#each feeds}}
{{this.title}}
{{this.description}}
{{#each items}}
{{this.title}}
{{{this.content}}}
{{/each}}
{{/each}}
```
You can also use any helper in the [handlebars-helpers](https://github.com/helpers/handlebars-helpers) library:
```html
{{#is intro "A certain intro"}}
A certain intro was used.
{{/is}}
```
## Contributing
All patches, fixes, and ideas welcome! Please read [contributing.md](contributing.md) for furthers details.
## License
[](https://opensource.org/licenses/Apache-2.0)
Copyright 2021, Hughes Domains, LLC.