Skip to content

channel.mdx

Latest commit

 

History

History
49 lines (40 loc) · 2.6 KB

channel.mdx

File metadata and controls

49 lines (40 loc) · 2.6 KB
title Channel
description Learn about the channel configuration block for RSS feed metadata. Configure feed title, description, author, and other RSS channel properties.

The channel configuration block defines your feed metadata.

This example is a complete feed config so you can see the channel block in context:

channel:
  url: https://example.com
  title: "My Custom Feed"
  description: "A feed of the latest news from Example.com"
  author: "jane.doe@example.com (Jane Doe)"
  ttl: 60
  language: "en"
  time_zone: "Europe/Berlin"
selectors:
  items:
    selector: "article"
  title:
    selector: "h2"
  url:
    selector: "a"
    extractor: "href"

Options

Attribute Required Description
url Required The URL of the website to scrape.
title Optional The title of the RSS feed. Defaults to the website's title.
description Optional A description for the RSS feed. Defaults to the website's meta description.
author Optional The author of the feed, in the format email (Name).
ttl Optional The "time to live" for the feed in minutes. Defaults to the max-age from the response headers, or 360.
language Optional The language of the feed. Defaults to the lang attribute of the <html> tag.
time_zone Optional The time zone for parsing dates. See the list of tz database time zones.

Notes

  • language is runtime-validated. Use a valid language code such as en, not an arbitrary string.
  • author should follow the RSS-style email (Name) format when you set it explicitly.
  • time_zone must be a known TZ database identifier such as UTC or Europe/Berlin.

For detailed documentation on the Ruby API, see the official YARD documentation.