hexo-generator-feed


Generate Atom 1.0 or RSS 2.0 feed.

Install

`` bash
npm install hexo-generator-feed --save
`

- Hexo 4+: 2.x
- Hexo 3: 1.x
- Hexo 2: 0.x

Use

In the front-matter of your post, you can optionally add a description, intro or excerpt setting to write a summary for the post. Otherwise the summary will default to the excerpt or the first 140 characters of the post.

Options

You can configure this plugin in _config.yml.

` yaml
feed:
enable: true
type: atom
path: atom.xml
limit: 20
hub:
content:
content_limit: 140
content_limit_delim: ' '
order_by: -date
icon: icon.png
autodiscovery: true
`
- enable - Enables or disables this plugin. Enabled by default.
- type - Feed type. atom or rss2. Specify ['atom', 'rss2'] to output both types. (Default: atom)
* Example:
` yaml
feed:
# Generate atom feed
type: atom

# Generate both atom and rss2 feeds
type:
- atom
- rss2
path:
- atom.xml
- rss2.xml
`
- path - Feed path. When both types are specified, path must follow the order of type value. (Default: atom.xml/rss2.xml)
- limit - Maximum number of posts in the feed (Use 0 or false to show all posts)
- hub - (optional) URL of the PubSubHubbub hubs (Leave it empty if you don't use it)
- content - (optional) set to 'true' to include the contents of the entire post in the feed.
- content_limit - (optional) Default length of post content used in summary. Only used, if content setting is false and no custom post description present.
- content_limit_delim - (optional) If content_limit is used to shorten post contents, only cut at the last occurrence of this delimiter before reaching the character limit. Not used by default.
- order_by - Feed order-by. (Default: -date)
- icon - (optional) Custom feed icon. Defaults to a gravatar of email specified in the main config.
- autodiscovery - Add feed autodiscovery. (Default: true`)
* Many themes already offer this feature, so you may also need to adjust the theme's config if you wish to disable it.