--- title: RSS Templates linktitle: RSS Templates description: Hugo ships with its own RSS 2.0 template that requires almost no configuration, or you can create your own RSS templates. date: 2017-02-01 publishdate: 2017-02-01 lastmod: 2017-02-01 keywords: [rss, xml, templates] categories: [templates] menu: docs: parent: "templates" weight: 150 weight: 150 sections_weight: 150 draft: false aliases: [/templates/rss/] toc: true --- ## RSS Template Lookup Order See [Template Lookup Order](/templates/lookup-order/) for the complete reference. {{% note "Hugo Ships with an RSS Template" %}} Hugo ships with its own [RSS 2.0 template](#the-embedded-rss-xml). The embedded template will be sufficient for most use cases. {{% /note %}} RSS pages are of the type `Page` and have all the [page variables](/variables/page/) available to use in the templates. ### Section RSS A [section’s][section] RSS will be rendered at `/
/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 The table below shows the RSS template lookup order for the different page kinds. The first listing shows the lookup order when running with a theme (`demoTheme`). {{< datatable-filtered "output" "layouts" "OutputFormat == RSS" "Example" "OutputFormat" "Suffix" "Template Lookup Order" >}} ## 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][config]. The following values will also be included in the RSS output if specified in your site’s configuration: ```toml 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 2.0]. ```xml {{ if eq .Title .Site.Title }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{.}} on {{ end }}{{ .Site.Title }}{{ end }} {{ .Permalink }} Recent content {{ if ne .Title .Site.Title }}{{ with .Title }}in {{.}} {{ end }}{{ end }}on {{ .Site.Title }} Hugo -- gohugo.io{{ with .Site.LanguageCode }} {{.}}{{end}}{{ with .Site.Author.email }} {{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}{{end}}{{ with .Site.Author.email }} {{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}{{end}}{{ with .Site.Copyright }} {{.}}{{end}}{{ if not .Date.IsZero }} {{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}{{ end }} {{ with .OutputFormats.Get "RSS" }} {{ printf "" .Permalink .MediaType | safeHTML }} {{ end }} {{ range .Data.Pages }} {{ .Title }} {{ .Permalink }} {{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }} {{ with .Site.Author.email }}{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}{{end}} {{ .Permalink }} {{ .Summary | html }} {{ end }} ``` {{% 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. ``` ``` {{% /warning %}} ## Reference your RSS Feed in `` In your `header.html` template, you can specify your RSS feed in your `` tag using Hugo's [Output Formats][Output Formats] like this: ``` {{ range .AlternativeOutputFormats -}} {{ end -}} ``` If you only want the RSS link, you can query the formats: ``` {{ with .OutputFormats.Get "rss" -}} {{ end -} ``` [config]: /getting-started/configuration/ [embedded]: #the-embedded-rss-xml [RSS 2.0]: http://cyber.law.harvard.edu/rss/rss.html "RSS 2.0 Specification" [section]: /content-management/sections/ [Output Formats]: /templates/output-formats/#link-to-output-formats