github.com/lyeb/hugo@v0.47.1/docs/content/en/templates/rss.md (about)

     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-rss-xml). 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., http://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 in your site’s configuration:
    47  
    48  ```toml
    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  ```
    55  
    56  ## The Embedded rss.xml
    57  
    58  This is the default RSS template that ships with Hugo. It adheres to the [RSS 2.0 Specification][RSS 2.0].
    59  
    60  ```xml
    61  <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
    62    <channel>
    63      <title>{{ if eq  .Title  .Site.Title }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{.}} on {{ end }}{{ .Site.Title }}{{ end }}</title>
    64      <link>{{ .Permalink }}</link>
    65      <description>Recent content {{ if ne  .Title  .Site.Title }}{{ with .Title }}in {{.}} {{ end }}{{ end }}on {{ .Site.Title }}</description>
    66      <generator>Hugo -- gohugo.io</generator>{{ with .Site.LanguageCode }}
    67      <language>{{.}}</language>{{end}}{{ with .Site.Author.email }}
    68      <managingEditor>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</managingEditor>{{end}}{{ with .Site.Author.email }}
    69      <webMaster>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</webMaster>{{end}}{{ with .Site.Copyright }}
    70      <copyright>{{.}}</copyright>{{end}}{{ if not .Date.IsZero }}
    71      <lastBuildDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</lastBuildDate>{{ end }}
    72      {{ with .OutputFormats.Get "RSS" }}
    73          {{ printf "<atom:link href=%q rel=\"self\" type=%q />" .Permalink .MediaType | safeHTML }}
    74      {{ end }}
    75      {{ range .Pages }}
    76      <item>
    77        <title>{{ .Title }}</title>
    78        <link>{{ .Permalink }}</link>
    79        <pubDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</pubDate>
    80        {{ with .Site.Author.email }}<author>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</author>{{end}}
    81        <guid>{{ .Permalink }}</guid>
    82        <description>{{ .Summary | html }}</description>
    83      </item>
    84      {{ end }}
    85    </channel>
    86  </rss>
    87  ```
    88  
    89  {{% warning "XML Header" %}}
    90  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.
    91  ```
    92  <?xml version="1.0" encoding="utf-8" standalone="yes" ?>
    93  ```
    94  {{% /warning %}}
    95  
    96  ## Reference your RSS Feed in `<head>`
    97  
    98  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:
    99  
   100  ```go-html-template
   101  {{ range .AlternativeOutputFormats -}}
   102      {{ printf `<link rel="%s" type="%s" href="%s" title="%s" />` .Rel .MediaType.Type .Permalink $.Site.Title | safeHTML }}
   103  {{ end -}}
   104  ```
   105  
   106  If you only want the RSS link, you can query the formats:
   107  
   108  ```go-html-template
   109  {{ with .OutputFormats.Get "rss" -}}
   110      {{ printf `<link rel="%s" type="%s" href="%s" title="%s" />` .Rel .MediaType.Type .Permalink $.Site.Title | safeHTML }}
   111  {{ end -}}
   112  ```
   113  
   114  Either of the two snippets above will generate the below `link` tag on the site homepage for RSS output:
   115  
   116  ```html
   117  <link rel="alternate" type="application/rss+xml" href="https://example.com/index.xml" title="Site Title">
   118  ```
   119  
   120  _We are assuming `BaseURL` to be `https://example.com/` and `$.Site.Title` to be `"Site Title"` in this example._
   121  
   122  [config]: /getting-started/configuration/
   123  [embedded]: #the-embedded-rss-xml
   124  [RSS 2.0]: http://cyber.law.harvard.edu/rss/rss.html "RSS 2.0 Specification"
   125  [section]: /content-management/sections/
   126  [Output Formats]: /templates/output-formats/#link-to-output-formats