syndication.md

syndication: Build syndication feeds for groups of pages.

Page types

• rss: A RSS syndication page
• atom: An Atom syndication page
• archive: An archive page is automatically created for each syndication.

Documentation

The Syndication feature implements generation of a RSS and [Atom](https://en.wikipedia.org/wiki/Atom_(Web_standard\)) feed for a page or group of pages.

Add a syndication metadata to a page to declare it as the index for a group of page. RSS and Atom feeds will appear next to the page, containing pages selected in the syndication metadata.

One page is used to define the syndication, using "syndication_*" tags.

Use a data page without type to define a contentless syndication page

Syndication metadata

Example front page for a blog page:

---
pages: blog/*
syndication: yes
template: blog.html
---
# My blog

See metadata documentation for a reference on the syndication field.

Syndication of taxonomies

Each category page in each taxonomy automatically defines a syndication metadata equivalent to this:

syndication:
  add_to: no

This would automatically generates RSS and Atom feeds with all pages in that category, but those feed links will only be added to the category page itself.

You can use the syndication metadata in your taxonomy categories to customize titles and description in your categories feeds, like with any other page.

Templates

See the example templates for working syndication.rss and syndication.atom templates, that are used by the generated RSS and Atom pages.

syndicated_pages(page=None, limit=None)

Templates can use the syndicated_pages function to list syndicated pages for a page, sorted with the most recently syndicated first.

page can be a page, a path to a page, or omitted, in which case the current page is used. page can also be a list of pages, which will be sorted by syndiaction date and sampled.

limit is the number of pages to return, or, if omitted, all the pages are returned.

Back to reference index