{{rss:url}}

The {{rss:url}} substitution parameter evaluates to the canonical URL for the generated RSS feed.

For example, this documentation site has the following headers set on the root node:

Canonical-URL: https://documentation.uriel.foo
RSS-URL: /rss.xml

As a result, when we use the {{rss:url}} parameter, it evaluates to the following value:

https://documentation.uriel.foo/rss.xml

Typical Usage

The intended use of this parameter is to include it in a template, where it is included on every page of your site.

For example, here the {{rss:url}} parameter is wrapped inside of a tag that references the RSS feed. The HTML looks like this:

<link rel="alternate"
      type="application/rss+xml"
      href="{{rss:url}}">

When the site is built, this evaluates to:

<link rel="alternate"
      type="application/rss+xml"
      href="https://documentation.uriel.foo/rss.xml">

Required Headers

The RSS-URL header must be set in order for this parameter to operate correctly. If you try to use this parameter without the RSS feed being enabled, you will get an error like this when Uriel tries to build the site:

copying 'static' to 'public', overwriting previous contents
initializing soju
initializing handlers
reading node files
rendering node content
parameter error:
  nodes/index
    templates/homepage.html
    templates/top.html
      '{{rss:url}}'
uriel: 'RSS-URL' header not set

See the RSS, Sitemap, robots.txt page for more information about getting Uriel to generate an RSS feed.

Tags: parameters, rss