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

Frontmatter 配置

你可以通过配置页面 Frontmatter 来控制每个 Feed 条目的生成方式。

添加与移除

默认情况下,所有文章都会被添加到 Feed 流中。若要在 Feed 中移除某个页面,请在 Frontmatter 中设置 feed: false。

基础信息

插件会自动读取以下标准的 Frontmatter 属性来填充 Feed 条目。

title

  • 类型: string

页面标题。如果未指定,默认自动读取页面的第一个 h1 标题内容。

description

  • 类型: string

页面的描述或摘要。

date

  • 类型: Date

页面的发布日期。

article

  • 类型: boolean

该页面是否为一篇文章。

如果设置为 false,该页面将被视为非文章页面,并且不会包含在最终的 Feed 中。

copyright

  • 类型: string

页面的版权信息。

cover / image / banner

  • 类型: string

用作页面封面的图片。必须是完整的 URL 链接或绝对路径。

Feed 选项

你可以使用 feed 对象来覆盖默认属性,或为 RSS/Atom/JSON 条目提供特定的配置。

feed.title

  • 类型: string

该条目在 Feed 中显示的标题。

feed.description

  • 类型: string

该条目在 Feed 中显示的描述。

feed.content

  • 类型: string

该条目在 Feed 中的内容。

feed.author

  • 类型: FeedAuthor[] | FeedAuthor

该 Feed 条目的作者。

FeedAuthor 格式
interface FeedAuthor {
  /**
   * 作者姓名
   */
  name?: string

  /**
   * 作者邮箱
   */
  email?: string

  /**
   * 作者网站
   *
   * @description 仅限 json 格式
   */
  url?: string

  /**
   * 作者头像
   *
   * @description 仅限 json 格式
   */
  avatar?: string
}

feed.contributor

  • 类型: FeedContributor[] | FeedContributor

该 Feed 条目的贡献者。

FeedContributor 格式
interface FeedContributor {
  /**
   * 作者姓名
   */
  name?: string

  /**
   * 作者邮箱
   */
  email?: string

  /**
   * 作者网站
   *
   * @description 仅限 json 格式
   */
  url?: string

  /**
   * 作者头像
   *
   * @description 仅限 json 格式
   */
  avatar?: string
}

feed.guid

  • 类型: string

Feed 条目的唯一标识符,用于识别该条目。

提示

你应该确保每个 Feed 条目都有一个唯一的 GUID。

在 GitHub 上编辑此页
上次更新: 2025/11/29 06:25
贡献者: Mister-Hope
上一页
插件配置
下一页
频道配置