Modulehakyll-4.17.0.0Haskell2010

Hakyll.Web.Feed

A Module that allows easy rendering of RSS feeds.

The main rendering functions (renderRss, renderAtom) all assume that you pass the list of items so that the most recent entry in the feed is the first item in the list.

Also note that the context should have (at least) the following fields to produce a correct feed:

$title$ : Title of the item
$description$ : Description to appear in the feed
$url$ : URL to the item - this is usually set automatically.

In addition, the posts should be named according to the rules for dateField

Note that for XML-based feeds (i.e. Atom and RSS) field values are not escaped! However, the default renderRss and renderAtom functions will validate the produced XML. Use the -NoValidate functions instead if you need to skip this validation.

1 type
11 values

Packagehakyll-4.17.0.0
Exports12
LanguageHaskell2010
LicenceBSD-3-Clause
SourceFeed.hs

datadata FeedConfiguration

This is a data structure to keep the configuration of a feed.

Constructors

FeedConfiguration
- feedTitle :: String
  Title of the feed.
- feedDescription :: String
  Description of the feed.
- feedAuthorName :: String
  Name of the feed author.
- feedAuthorEmail :: String
  Email of the feed author. Set this to the empty String to leave out the email address.
- feedRoot :: String
  Absolute root URL of the feed site (e.g. http://jaspervdj.be)

Instances2Eq, Show

Eq FeedConfigurationDefined in hakyll-4.17.0.0 · Hakyll.Web.Feed
Show FeedConfigurationDefined in hakyll-4.17.0.0 · Hakyll.Web.Feed

valuerenderRss

:: FeedConfiguration
Feed configuration
-> Context String
Item context
-> [Item String]
Feed items
-> Compiler (Item String)
Resulting feed

Render an RSS feed with a number of items.

The resulting RSS feed will be validated automatically.

valuerenderRssNoValidate

:: FeedConfiguration
Feed configuration
-> Context String
Item context
-> [Item String]
Feed items
-> Compiler (Item String)
Resulting feed

Render an RSS feed with a number of items.

The resulting feed will not be validated. Prefer to use renderRss when possible.

valuerenderAtom

:: FeedConfiguration
Feed configuration
-> Context String
Item context
-> [Item String]
Feed items
-> Compiler (Item String)
Resulting feed

Render an Atom feed with a number of items.

The resulting Atom feed will be validated automatically.

valuerenderAtomNoValidate

:: FeedConfiguration
Feed configuration
-> Context String
Item context
-> [Item String]
Feed items
-> Compiler (Item String)
Resulting feed

Render an Atom feed with a number of items.

The resulting feed will not be validated. Prefer to use renderAtom when possible.

valuerenderJson

:: FeedConfiguration
Feed configuration
-> Context String
Item context
-> [Item String]
Feed items
-> Compiler (Item String)
Resulting feed

Render a JSON feed with a number of items.

Items' bodies will be put into content_html field of the resulting JSON; the content field will not be set.

valuerenderRssWithTemplates

:: Template
Feed template
-> Template
Item template
-> FeedConfiguration
Feed configuration
-> Context String
Item context
-> [Item String]
Feed items
-> Compiler (Item String)
Resulting feed

Render an RSS feed using given templates with a number of items.

The resulting RSS feed will be validated automatically.

valuerenderRssWithTemplatesNoValidate

:: Template
Feed template
-> Template
Item template
-> FeedConfiguration
Feed configuration
-> Context String
Item context
-> [Item String]
Feed items
-> Compiler (Item String)
Resulting feed

Render an RSS feed using given templates with a number of items.

The resulting feed will not be validated. Prefer to use renderRssWithTemplates when possible.

valuerenderAtomWithTemplates

:: Template
Feed template
-> Template
Item template
-> FeedConfiguration
Feed configuration
-> Context String
Item context
-> [Item String]
Feed items
-> Compiler (Item String)
Resulting feed

Render an Atom feed using given templates with a number of items.

The resulting Atom feed will be validated automatically.

valuerenderAtomWithTemplatesNoValidate

:: Template
Feed template
-> Template
Item template
-> FeedConfiguration
Feed configuration
-> Context String
Item context
-> [Item String]
Feed items
-> Compiler (Item String)
Resulting feed

Render an Atom feed using given templates with a number of items.

The resulting feed will not be validated. Prefer to use renderAtomWithTemplates when possible.

valuerenderJsonWithTemplates

:: Template
Feed template
-> Template
Item template
-> FeedConfiguration
Feed configuration
-> Context String
Item context
-> [Item String]
Feed items
-> Compiler (Item String)
Resulting feed

Render a JSON feed using given templates with a number of items.

valuevalidateXMLFeed :: Item String -> Compiler (Item String)

Validate that a feed contains only correct XML.