跳至主要內容

Feed 支持

大约 2 分钟高级高级Feed

vuepress-theme-hope 通过内置 @vuepress/plugin-feedopen in new window 插件来为你提供 feed 支持。想使用它,你应该手动在你的项目中安装 @vuepress/plugin-feed

相关信息

vuepress-theme-hope 将主题选项中的 plugins.feed 选项作为插件选项提供给 @vuepress/plugin-feed

使用

@vuepress/plugin-feed 插件可为你生成以下三种格式的 feed 文件:

  • Atom 1.0
  • JSON 1.1
  • RSS 2.0

如果可以,请尽可能使用 RSS。Atom 和 JSON 是为了最好的兼容性而提供的。

请按照需要生成的格式,在主题选项中设置 plugins.feed.atom, plugins.feed.jsonplugins.feed.rsstrue

提示

当然,你可以都输出它们,这不是一个三选一。

考虑到现在 Feed 已经很小众,此插件旨在提供最小配置来尽可能自动生成详细的 Feed 文件。当然此插件也预留了充足的设置项,以让你自由定义 Feed 的输出内容。

频道设置

你可以在主题选项中通过设置 plugins.feed.channel 选项来自自定义 Feed 频道的各项信息。

我们推荐进行如下设置:

  • 将建立 Feed 的日期转换为 ISOString 写入到 channel.pubDate
  • 通过 channel.ttl 中设置内容的更新周期(单位: 分钟)
  • 通过 channel.copyright 设置版权信息,或回退到主题选项中的 copyright
  • 通过 channel.author 设置频道作者,或回退到主题选项中的 author

默认频道设置

  • 频道的标题、描述默认为站点的名称与链接。

  • 频道的链接、最后更新时间会由插件自动生成。

  • 频道的版权信息会尝试从页脚的版权信息中读取。

详细的选项及其默认值详见 Feed 频道文档open in new window

生成控制

项目默认生成逻辑

默认情况下,所有文章均会被添加至 feed 流。

你可以通过配置 frontmatter 中的 feed 选项,对特定文章的 feed 项目生成的内容进行控制,详见 Feed frontmatter 文档open in new window

你可以通过配置插件选项中的 getter,完全控制 Feed 项目的生成逻辑,详见 Feed 获取器文档open in new window

多语言配置

插件会针对每个语言生成单独的 Feed。

你可以通过插件选项中的 locales 分别对不同语言提供不同的默认设置。