Feed Getter

You can take full control of how feed items are generated by configuring the getter object in the plugin options.

getter.title

  • Type: (page: Page, app: App) => string
  • Details: Customizes the title of the feed item.
  • Type: (page: Page, app: App) => string
  • Details: Customizes the link (URL) of the feed item.

getter.description

  • Type: (page: Page, app: App) => string | undefined
  • Details: Customizes the description or summary of the feed item.

Tips

Since Atom supports HTML in summaries, you can return HTML content here. However, to ensure correct rendering, the returned string must start with the prefix html:.

getter.content

  • Type: (page: Page, app: App) => string
  • Details: Customizes the main content of the feed item.

getter.author

  • Type: (page: Page, app: App) => FeedAuthor[]
  • Details: Retrieves the list of authors for the feed item.

Tips

This getter should return an empty array [] if no author information is available.

FeedAuthor format
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
}

getter.category

  • Type: (page: Page, app: App) => FeedCategory[] | undefined
  • Details: Retrieves the categories associated with the feed item.
FeedCategory format
interface FeedCategory {
  /**
   * Category Name
   */
  name: string

  /**
   * A string that identifies a categorization taxonomy
   *
   * @description rss format only
   */
  domain?: string

  /**
   * The categorization scheme via a URI
   *
   * @description atom format only
   */
  scheme?: string
}

getter.enclosure

  • Type: (page: Page, app: App) => FeedEnclosure | undefined
  • Details: Specifies a media enclosure (e.g., audio, video, or attachment) for the feed item.
FeedEnclosure format
interface FeedEnclosure {
  /**
   * Enclosure link
   */
  url: string

  /**
   * The MIME type of the enclosure
   *
   * @description should be a standard MIME Type, rss format only
   */
  type: string

  /**
   * Size in bytes
   *
   * @description rss format only
   */
  length?: number
}

getter.publishDate

  • Type: (page: Page, app: App) => Date | undefined
  • Details: Determines the publication date of the feed item.

getter.lastUpdateDate

  • Type: (page: Page, app: App) => Date
  • Details: Determines the last modification date of the feed item.

getter.image

  • Type: (page: Page, app: App) => string
  • Details: Sets a featured image for the feed item.

Tips

Ensure the returned string is a full, absolute URL.

getter.contributor

  • Type: (page: Page, app: App) => FeedContributor[]
  • Details: Retrieves the list of contributors for the feed item.

Tips

This getter should return an empty array [] if no contributor information is available.

FeedContributor format
interface FeedContributor {
  /**
   * Contributor name
   */
  name?: string

  /**
   * Contributor email
   */
  email?: string

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

  /**
   * Contributor avatar
   *
   * @description json format only
   */
  avatar?: string
}
  • Type: (page: Page, app: App) => string | undefined
  • Details: Specifies the copyright information for the feed item.