phoenix/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-07-19 15:19:02 +00:00
Code Issues Packages Projects Releases Wiki Activity
hugo/content/templates/rss.md
Bjørn Erik Pedersen 2c0d1ccdcd Squashed 'docs/' changes from b0470688..73f355ce 
73f355ce Update theme
83ff50c2 Use example.com in examples
71292134 Add alias news > release-notes
2e15f642 Update theme
8eef09d2 Add Pygments configuration
572b9e75 Clean up the code shortcode use
a1b2fd3b Remove the code fence language codes
1473b1d9 Remove redundant text
b92c2042 Update theme
8f439c28 Edit contributing section in README
8bcf8a19 Add contributing section to README
4c44ee1c Fix broken content file
2bdc7710 Clarify .Data.Pages sorting in lists.md
092271c2 Use infinitive mood for main titles
b9b8abef Update theme to reflect change to home page content
b897b71b Change copy to use sentence case
fd675ee5 Enable RSS feed for sections
060a5e27 Correct movie title in taxonomies.md
6a5ca96a Update displayed site name for Hub
22f4b7a4 Add example of starting up the local server
d9612cb3 Update theme
a8c3988a Update theme
4198189d Update theme
12d6b016 Update theme
2b1c4197 Update theme
b6d90a1e Fix News release titles
cfe751db Add some build info to README

git-subtree-dir: docs
git-subtree-split: 73f355ce0dd88d032062ea70067431ab980cdd8d
2017-07-21 11:00:08 +02:00

5 KiB
Raw Blame History

title linktitle description date publishdate lastmod categories menu weight sections_weight draft aliases toc
RSS Templates RSS Templates Hugo ships with its own RSS 2.0 template that requires almost no configuration, or you can create your own RSS templates. 2017-02-01 2017-02-01 2017-02-01
templates
docs
parent weight
templates 150
150 150 false
/templates/rss/
true

RSS Template Lookup Order

You can use a single RSS template to generate all of your RSS feeds or create a specific template for each individual feed.

  1. /layouts/section/<section>.rss.xml
  2. /layouts/_default/rss.xml
  3. /themes/<theme>/layouts/section/<section>.rss.xml
  4. /themes/<theme>/layouts/_default/rss.xml

{{% note "Hugo Ships with an RSS Template" %}} Hugo ships with its own RSS 2.0 template. The embedded template will be sufficient for most use cases. {{% /note %}}

RSS pages are of the type Page and have all the page variables available to use in the templates.

Section RSS

A section’s RSS will be rendered at /<SECTION>/index.xml (e.g., http://spf13.com/project/index.xml).

Hugo provides the ability for you to define any RSS type you wish and can have different RSS files for each section and taxonomy.

Lookup Order for RSS Templates

Main RSS

  1. /layouts/rss.xml
  2. /layouts/_default/rss.xml
  3. Embedded rss.xml

Section RSS

  1. /layouts/section/<SECTION>.rss.xml
  2. /layouts/_default/rss.xml
  3. /themes/<THEME>/layouts/section/<SECTION>.rss.xml
  4. /themes/<THEME>/layouts/_default/rss.xml
  5. Embedded rss.xml

Taxonomy RSS

  1. /layouts/taxonomy/<SINGULAR>.rss.xml
  2. /layouts/_default/rss.xml
  3. /themes/<THEME>/layouts/taxonomy/<SINGULAR>.rss.xml
  4. /themes/<THEME>/layouts/_default/rss.xml
  5. Embedded rss.xml

Configure RSS

By default, Hugo will create an unlimited number of RSS entries. You can limit the number of articles included in the built-in RSS templates by assigning a numeric value to rssLimit: field in your project's config file.

The following values will also be included in the RSS output if specified in your site’s configuration:

languageCode = "en-us"
copyright = "This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License."

[author]
    name = "My Name Here"

The Embedded rss.xml

This is the default RSS template that ships with Hugo. It adheres to the RSS 2.0 Specification.

<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <title>{{ with .Title }}{{.}} on {{ end }}{{ .Site.Title }}</title>
    <link>{{ .Permalink }}</link>
    <description>Recent content {{ with .Title }}in {{.}} {{ end }}on {{ .Site.Title }}</description>
    <generator>Hugo -- gohugo.io</generator>{{ with .Site.LanguageCode }}
    <language>{{.}}</language>{{end}}{{ with .Site.Author.email }}
    <managingEditor>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</managingEditor>{{end}}{{ with .Site.Author.email }}
    <webMaster>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</webMaster>{{end}}{{ with .Site.Copyright }}
    <copyright>{{.}}</copyright>{{end}}{{ if not .Date.IsZero }}
    <lastBuildDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</lastBuildDate>{{ end }}
    <atom:link href="{{.URL}}" rel="self" type="application/rss+xml" />
    {{ range first 15 .Data.Pages }}
    <item>
      <title>{{ .Title }}</title>
      <link>{{ .Permalink }}</link>
      <pubDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</pubDate>
      {{ with .Site.Author.email }}<author>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</author>{{end}}
      <guid>{{ .Permalink }}</guid>
      <description>{{ .Content | html }}</description>
    </item>
    {{ end }}
  </channel>
</rss>

{{% warning "XML Header" %}} Hugo will automatically add the following header line to this file on render. Please do not include this in the template as it's not valid HTML.

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>

{{% /warning %}}

Reference your RSS Feed in <head>

In your header.html template, you can specify your RSS feed in your <head></head> tag like this:

{{ if .RSSLink }}
  <link href="{{ .RSSLink }}" rel="alternate" type="application/rss+xml" title="{{ .Site.Title }}" />
  <link href="{{ .RSSLink }}" rel="feed" type="application/rss+xml" title="{{ .Site.Title }}" />
{{ end }}

...with the auto-discovery link specified by the line with rel="alternate".

The .RSSLink will render the appropriate RSS feed URL for the section, whether it's everything, posts in a section, or a taxonomy.

If you reference your RSS link, be sure to specify the MIME type with type="application/rss+xml".

<a href="{{ .URL }}" type="application/rss+xml" target="_blank">{{ .SomeText }}</a>