rss.md (3444B)
1 ---
2 title: RSS Templates
3 linktitle: RSS Templates
4 description: Hugo ships with its own RSS 2.0 template that requires almost no configuration, or you can create your own RSS templates.
5 date: 2017-02-01
6 publishdate: 2017-02-01
7 lastmod: 2017-02-01
8 keywords: [rss, xml, templates]
9 categories: [templates]
10 menu:
11 docs:
12 parent: "templates"
13 weight: 150
14 weight: 150
15 sections_weight: 150
16 draft: false
17 toc: true
18 ---
19
20 ## RSS Template Lookup Order
21
22 See [Template Lookup Order](/templates/lookup-order/) for the complete reference.
23
24 {{% note "Hugo Ships with an RSS Template" %}}
25 Hugo ships with its own [RSS 2.0 template](#the-embedded-rssxml). The embedded template will be sufficient for most use cases.
26 {{% /note %}}
27
28 RSS pages are of the type `Page` and have all the [page variables](/variables/page/) available to use in the templates.
29
30 ### Section RSS
31
32 A [section’s][section] RSS will be rendered at `/<SECTION>/index.xml` (e.g., [https://spf13.com/project/index.xml](https://spf13.com/project/index.xml)).
33
34 Hugo provides the ability for you to define any RSS type you wish and can have different RSS files for each section and taxonomy.
35
36 ## Lookup Order for RSS Templates
37
38 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`).
39
40 {{< datatable-filtered "output" "layouts" "OutputFormat == RSS" "Example" "OutputFormat" "Suffix" "Template Lookup Order" >}}
41
42 ## Configure RSS
43
44 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].
45
46 The following values will also be included in the RSS output if specified:
47
48 {{< code-toggle file="config" >}}
49 languageCode = "en-us"
50 copyright = "This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License."
51
52 [author]
53 name = "My Name Here"
54 {{< /code-toggle >}}
55
56 ## The Embedded rss.xml
57
58 This is the default RSS template that ships with Hugo:
59
60 https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_default/rss.xml
61
62 ## Reference your RSS Feed in `<head>`
63
64 In your `header.html` template, you can specify your RSS feed in your `<head></head>` tag using Hugo's [Output Formats][Output Formats] like this:
65
66 ```go-html-template
67 {{ range .AlternativeOutputFormats -}}
68 {{ printf `<link rel="%s" type="%s" href="%s" title="%s" />` .Rel .MediaType.Type .Permalink $.Site.Title | safeHTML }}
69 {{ end -}}
70 ```
71
72 If you only want the RSS link, you can query the formats:
73
74 ```go-html-template
75 {{ with .OutputFormats.Get "rss" -}}
76 {{ printf `<link rel="%s" type="%s" href="%s" title="%s" />` .Rel .MediaType.Type .Permalink $.Site.Title | safeHTML }}
77 {{ end -}}
78 ```
79
80 Either of the two snippets above will generate the below `link` tag on the site homepage for RSS output:
81
82 ```html
83 <link rel="alternate" type="application/rss+xml" href="https://example.com/index.xml" title="Site Title">
84 ```
85
86 _We are assuming `BaseURL` to be `https://example.com/` and `$.Site.Title` to be `"Site Title"` in this example._
87
88 [config]: /getting-started/configuration/
89 [embedded]: #the-embedded-rss-xml
90 [RSS 2.0]: https://cyber.harvard.edu/rss/rss.html "RSS 2.0 Specification"
91 [section]: /content-management/sections/
92 [Output Formats]: /templates/output-formats/#link-to-output-formats