Frontmatter Config

You can control each feed item generation by setting page frontmatter.

Additions and Removals

By default, all articles are added to the feed stream. Set feed: false in frontmatter to remove a page from feed.

Frontmatter Information

title

• Type: string

Automatically generated by VuePress, defaults to the h1 content of the page

description

• Type: string

Description of the page

date

• Type: Date

Date when the page was published

article

• Type: boolean

Whether the page is an article

If this is set to false, the page will not be included in the final feed.

copyright

• Type: string

Page copyright information

cover / image / banner

• Type: string

Image used as page cover , should be full link or absolute link.

Frontmatter Options

feed.title

• Type: string

The title of the feed item

feed.description

• Type: string

Description of the feed item

feed.content

• Type: string

The content of the feed item

feed.author

• Type: FeedAuthor[] | FeedAuthor

The author of the feed item

interface FeedAuthor {
  /**
   * Author name
   */
  name?: string

  /**
   * Author email
   */
  email?: string

  /**
   * Author site
   *
   * @description json format only
   */
  url?: string

  /**
   * Author avatar
   *
   * @description json format only
   */
  avatar?: string
}

feed.contributor

• Type: FeedContributor[] | FeedContributor

Contributors to feed item

interface FeedContributor {
  /**
   * Author name
   */
  name?: string

  /**
   * Author email
   */
  email?: string

  /**
   * Author site
   *
   * @description json format only
   */
  url?: string

  /**
   * Author avatar
   *
   * @description json format only
   */
  avatar?: string
}

feed.guid

• Type: string

The identifier of feed item, used to identify the feed item.