RSS feed generator. Add RSS feeds to any project. Supports enclosures and GeoRSS.
Usage
Create a new feed
var RSS = require('rss');
var feed = new RSS(feedOptions);
feedOptions
title
string Title of your site or feeddescription
optional string A short description of the feed.generator
optional string Feed generator.feed_url
url string Url to the rss feed.site_url
url string Url to the site that the feed is for.image_url
optional url string Small image for feed readers to use.docs
optional url string Url to documentation on this feed.managingEditor
optional string Who manages content in this feed.webMaster
optional string Who manages feed availability and technical support.copyright
optional string Copyright information for this feed.language
optional string The language of the content of this feed.categories
optional array of strings One or more categories this feed belongs to.pubDate
optional Date object or date string The publication date for content in the feedttl
optional integer Number of minutes feed can be cached before refreshing from source.hub
optional PubSubHubbub hub url Where is the PubSubHub hub located.custom_namespaces
optional object Put additional namespaces in element (without 'xmlns:' prefix)custom_elements
optional array Put additional elements in the feed (node-xml syntax)
Add items to a feed
An item can be used for a blog entry, project update, log entry, etc. Your RSS feed
can have any number of items. Most feeds use 20 or fewer items.
feed.item(itemOptions);
itemOptions
Feed XML
var xml = feed.xml({indent: true});
This returns the XML as a string.
indent
optional boolean or string What to use as a tab. Defaults to no tabs (compressed).
For example you can use '\t'
for tab character, or ' '
for two-space tabs. If you set it to
true
it will use four spaces.
Example Usage
var RSS = require('rss');
var feed = new RSS({
title: 'title',
description: 'description',
feed_url: 'http://example.com/rss.xml',
site_url: 'http://example.com',
image_url: 'http://example.com/icon.png',
docs: 'http://example.com/rss/docs.html',
managingEditor: 'Dylan Greene',
webMaster: 'Dylan Greene',
copyright: '2013 Dylan Greene',
language: 'en',
categories: ['Category 1','Category 2','Category 3'],
pubDate: 'May 20, 2012 04:00:00 GMT',
ttl: '60',
custom_namespaces: {
'itunes': 'http://www.itunes.com/dtds/podcast-1.0.dtd'
},
custom_elements: [
{'itunes:subtitle': 'A show about everything'},
{'itunes:author': 'John Doe'},
{'itunes:summary': 'All About Everything is a show about everything. Each week we dive into any subject known to man and talk about it as much as we can. Look for our podcast in the Podcasts app or in the iTunes Store'},
{'itunes:owner': [
{'itunes:name': 'John Doe'},
{'itunes:email': 'john.doe@example.com'}
]},
{'itunes:image': {
_attr: {
href: 'http://example.com/podcasts/everything/AllAboutEverything.jpg'
}
}},
{'itunes:category': [
{_attr: {
text: 'Technology'
}},
{'itunes:category': {
_attr: {
text: 'Gadgets'
}
}}
]}
]
});
feed.item({
title: 'item title',
description: 'use this for the content. It can include html.',
url: 'http://example.com/article4?this&that',
guid: '1123',
categories: ['Category 1','Category 2','Category 3','Category 4'],
author: 'Guest Author',
date: 'May 27, 2012',
lat: 33.417974,
long: -111.933231,
enclosure: {url:'...', file:'path-to-file'},
custom_elements: [
{'itunes:author': 'John Doe'},
{'itunes:subtitle': 'A short primer on table spices'},
{'itunes:image': {
_attr: {
href: 'http://example.com/podcasts/everything/AllAboutEverything/Episode1.jpg'
}
}},
{'itunes:duration': '7:04'}
]
});
var xml = feed.xml();
Notes
- You do not need to escape anything. This module will escape characters when necessary.
- This module is very fast but you might as well cache the output of xml() and serve
it until something changes.
Inspiration
I started this module years ago (April 2011) because there weren't any Node modules
for creating RSS. Nearly 50 modules
use RSS, as well as many web sites and the popular Ghost publishing platform.
Contributing
Contributions to the project are welcome. Feel free to fork and improve.
I do my best accept pull requests in a timely manor, especially when tests and updated docs
are included.
About the Author
Hi! Thanks for checking out this project! My name is Dylan Greene. When not overwhelmed with my two young kids I enjoy contributing
to the open source community. I'm also a tech lead at Opower.
![@dylang](https://img.shields.io/badge/twitter-dylang-blue.svg)
Here's some of my other Node projects:
Name | Description | npm Downloads |
---|
npm‑check | Check for outdated, incorrect, and unused dependencies. | ![npm-check](https://img.shields.io/npm/dm/npm-check.svg?style=flat-square) |
grunt‑notify | Automatic desktop notifications for Grunt errors and warnings. Supports OS X, Windows, Linux. | ![grunt-notify](https://img.shields.io/npm/dm/grunt-notify.svg?style=flat-square) |
shortid | Amazingly short non-sequential url-friendly unique id generator. | ![shortid](https://img.shields.io/npm/dm/shortid.svg?style=flat-square) |
grunt‑prompt | Interactive prompt for your Grunt config using console checkboxes, text input with filtering, password fields. | ![grunt-prompt](https://img.shields.io/npm/dm/grunt-prompt.svg?style=flat-square) |
xml | Fast and simple xml generator. Supports attributes, CDATA, etc. Includes tests and examples. | ![xml](https://img.shields.io/npm/dm/xml.svg?style=flat-square) |
changelog | Command line tool (and Node module) that generates a changelog in color output, markdown, or json for modules in npmjs.org's registry as well as any public github.com repo. | ![changelog](https://img.shields.io/npm/dm/changelog.svg?style=flat-square) |
space‑hogs | Discover surprisingly large directories from the command line. | ![space-hogs](https://img.shields.io/npm/dm/space-hogs.svg?style=flat-square) |
observatory | Beautiful UI for showing tasks running on the command line. | ![observatory](https://img.shields.io/npm/dm/observatory.svg?style=flat-square) |
captionbot | Get captions for image using Microsoft's CaptionBot 🤖 | ![captionbot](https://img.shields.io/npm/dm/captionbot.svg?style=flat-square) |
grunt‑attention | Display attention-grabbing messages in the terminal | ![grunt-attention](https://img.shields.io/npm/dm/grunt-attention.svg?style=flat-square) |
what‑dog | Get the breed of a dog from an image using Microsoft's what-dog. | ![what-dog](https://img.shields.io/npm/dm/what-dog.svg?style=flat-square) |
anthology | Module information and stats for any @npmjs user | ![anthology](https://img.shields.io/npm/dm/anthology.svg?style=flat-square) |
random‑puppy | Get a random imgur image url, by default a puppy. | ![random-puppy](https://img.shields.io/npm/dm/random-puppy.svg?style=flat-square) |
grunt‑cat | Echo a file to the terminal. Works with text, figlets, ascii art, and full-color ansi. | ![grunt-cat](https://img.shields.io/npm/dm/grunt-cat.svg?style=flat-square) |
This list was generated using anthology.
License
Copyright (c) 2017 Dylan Greene, contributors.
Released under the MIT license.
Screenshots are CC BY-SA (Attribution-ShareAlike).
Generated using grunt-readme with grunt-templates-dylang on Wednesday, January 11, 2017.
_To make changes to this document look in /templates/readme/