Skip to content

Latest commit

 

History

History
57 lines (51 loc) · 3.69 KB

rss.md

File metadata and controls

57 lines (51 loc) · 3.69 KB

rss: A RSS syndication page

Fields

  • aliases: Relative paths in the destination directory where the page should also show up. Like in Hugo, this can be used to maintain existing links when moving a page to a different location.
  • asset: If set to True for a file (for example, by a file: pattern in a directory index), the file is loaded as a static asset, regardless of whether a feature would load it.
  • author: A string with the name of the author for this page.
  • copyright: Copyright notice for the page. If missing, it's generated using template_copyright.
  • created_from: Page that generated this page.
  • data_type: Type of data for this file.
  • date: Publication date for the page.
  • description: The page description. If omitted, the page will have no description.
  • image: Image used for this post.
  • index: Page that defined the syndication for this feed
  • indexed: If true, the page appears in directory indices and in page filter results.
  • links: Extra metadata for external links.
  • nav: List of page paths, relative to the page defining the nav element, that are used for the navbar.
  • nav_title: Title to use when this page is linked in a navbar.
  • pages: The pages metadata can use to select a set of pages shown by the current page. Although default page.html template will not do anything with them, other page templates, like blog.html, use this to select the pages to show.
  • related: Readonly mapping of pages related to this page, indexed by name.
  • series: List of categories for the series taxonomy.
  • series_title: Series title from this page onwards.
  • site_name: Name of the site. If missing, it defaults to the title of the toplevel index page. If missing, it defaults to the name of the content directory.
  • site_url: Base URL for the site, used to generate an absolute URL to the page.
  • syndicated: Set to true if the page can be included in a syndication, else to false.
  • syndication: Defines syndication for the contents of this page.
  • syndication_date: Syndication date for this page.
  • tags: List of categories for the tags taxonomy.
  • template: Template used to render the page. Defaults to page.html, although specific pages of some features can default to other template names.
  • template_copyright: jinja2 template to use to generate copyright when it is not explicitly set.
  • template_description: jinja2 template to use to generate description when it is not explicitly set.
  • template_title: jinja2 template to use to generate title when it is not explicitly set.
  • title: Page title.

Documentation

RSS and Atom pages have these extra properties:

  • page.meta.template defaults to syndication.rss or syndication.atom instead of page.html
  • page.meta.date is the most recent date of the pages in the feed
  • page.meta.index is the page defining the syndication
  • page.meta.pages is a list of all the pages included in the syndication

Back to reference index