Gangmax Blog

Hexo "hexo-generator-feed" Plugin Configuration

From here.

You can configure this plugin in “_config.yml”:

1
2
3
4
5
6
7
8
9
10
11
12
13
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
  template:

The details of the configuration items:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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:
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 - 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.

template - Custom template path(s). This file will be used to generate feed xml file, see the default templates: atom.xml and rss2.xml.

Comments