VuePress 生态系统VuePress 生态系统
  • 主题指南
  • 默认主题
  • Hope 主题
  • Plume 主题
  • Reco 主题
  • 功能插件
  • Markdown 插件
  • 搜索插件
  • 博客插件
  • 渐进式应用插件
  • 统计分析插件
  • 搜索引擎优化插件
  • 开发插件
  • 工具插件
  • @vuepress/helper
  • English
  • 简体中文
GitHub
  • 主题指南
  • 默认主题
  • Hope 主题
  • Plume 主题
  • Reco 主题
  • 功能插件
  • Markdown 插件
  • 搜索插件
  • 博客插件
  • 渐进式应用插件
  • 统计分析插件
  • 搜索引擎优化插件
  • 开发插件
  • 工具插件
  • @vuepress/helper
  • English
  • 简体中文
GitHub
  • 博客
    • 指南
    • 配置
  • 评论
    • 指南
    • Giscus
    • Waline
    • Artalk
    • Twikoo
  • Feed
    • 指南
    • 插件配置
    • Frontmatter 配置
    • 频道设置
    • Feed 获取器

指南

使用

插件可为你生成以下三种格式的 feed 文件:

  • Atom 1.0
  • JSON 1.1
  • RSS 2.0

请按照需要生成的格式,在插件选项中设置 atom, json 或 rss 为 true。

为了正确生成 Feed 链接,你需要在插件选项中设置 hostname。

可读的预览

当你在浏览器中打开 Feed 文件时,我们会通过 xsl 模板将 atom 和 rss feed xml 魔法般地转换为可读的 html。你可以查看本站的 atom 和 rss feed 作为案例!

如果你想在开发服务器中预览 Feed,你需要在插件选项中设置 devServer: true。如果你没有使用默认的 http://localhost:{port},你还需要设置 devHostname。

频道设置

你可以通过设置 channel 选项来自自定义 Feed 频道的各项信息。

我们推荐进行如下设置:

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

详细的选项及其默认值详见 配置 → 频道设置

Feed 生成

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

你可以在 frontmatter 中配置 feed 和其他选项控制每个页面的 Feed 项目内容,详见 Frontmatter 选项 了解它们如何被转换。

你可以通过配置插件选项中的 getter 完全控制 Feed 项目的生成逻辑。 详细的选项及其默认值详见 配置 → Feed 获取器

多语言配置

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

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

在 GitHub 上编辑此页
上次更新: 2025/1/10 18:07
贡献者: Mister-Hope
Next
插件配置