Hexo Feed 生成器插件使用教程

Hexo Feed 生成器插件使用教程

hexo-generator-feedFeed generator for Hexo.项目地址:https://gitcode.com/gh_mirrors/he/hexo-generator-feed

1. 项目的目录结构及介绍

Hexo Feed 生成器插件的目录结构相对简单，主要包含以下文件和目录：

hexo-generator-feed/
├── index.js
├── lib/
│   ├── feed.js
│   └── generator.js
├── package.json
└── README.md

• index.js: 插件的入口文件，负责初始化和加载插件功能。
• lib/: 包含插件的核心逻辑文件。
  • feed.js: 负责生成 RSS 和 Atom 订阅源。
  • generator.js: 负责生成订阅源的具体内容。
• package.json: 包含插件的元数据，如名称、版本、依赖等。
• README.md: 插件的说明文档，包含安装和使用说明。

2. 项目的启动文件介绍

插件的启动文件是 index.js，它负责初始化插件并加载核心功能。以下是 index.js 的主要内容：

'use strict';

var assign = require('object-assign');
var generator = require('./lib/generator');

module.exports = function(hexo) {
  assign(hexo.config.feed, {
    type: 'atom',
    path: 'atom.xml',
    limit: 20
  });

  hexo.extend.generator.register('feed', generator);
};

• assign(hexo.config.feed, {...}): 设置默认的配置选项。
• hexo.extend.generator.register('feed', generator): 注册生成器，用于生成订阅源。

3. 项目的配置文件介绍

插件的配置文件是 _config.yml，你需要在 Hexo 项目的根目录下添加相关配置。以下是一个示例配置：

feed:
  type: atom
  path: atom.xml
  limit: 20
  hub:
  content:
  content_limit: 140
  content_limit_delim: ' '
  order_by: -date
  icon:
  autodiscovery: true
  template:

• type: 订阅源的类型，可以是 atom 或 rss2。
• path: 生成的订阅源文件路径。
• limit: 显示的文章数量限制。
• hub: PubSubHubbub 的 URL。
• content: 是否包含文章内容。
• content_limit: 文章内容的限制长度。
• content_limit_delim: 文章内容截断的分隔符。
• order_by: 文章排序方式。
• icon: 订阅源的图标。
• autodiscovery: 是否启用自动发现功能。
• template: 自定义模板文件路径。

通过以上配置，你可以自定义生成的订阅源的格式和内容。

hexo-generator-feedFeed generator for Hexo.项目地址:https://gitcode.com/gh_mirrors/he/hexo-generator-feed