RSS 模板
配置
默认情况下,当您构建站点时,Hugo 会为主页、部分、分类和术语页面生成 RSS 订阅。在站点配置中控制订阅生成。例如,要为主页和部分页面生成订阅,而不是为分类和术语页面生成订阅:
hugo.
outputs:
home:
- html
- rss
section:
- html
- rss
taxonomy:
- html
term:
- html
[outputs]
home = ['html', 'rss']
section = ['html', 'rss']
taxonomy = ['html']
term = ['html']
{
"outputs": {
"home": [
"html",
"rss"
],
"section": [
"html",
"rss"
],
"taxonomy": [
"html"
],
"term": [
"html"
]
}
}
要禁用所有 页面种类 的订阅生成:
hugo.
disableKinds:
- rss
disableKinds = ['rss']
{
"disableKinds": [
"rss"
]
}
默认情况下,每个订阅中的项目数量是无限的。根据需要在站点配置中更改此设置:
hugo.
services:
rss:
limit: 42
[services]
[services.rss]
limit = 42
{
"services": {
"rss": {
"limit": 42
}
}
}
将 limit
设置为 -1
来生成无限数量的项目。
如果存在,内置的 RSS 模板将从您的站点配置中呈现以下值:
hugo.
copyright: © 2023 ABC Widgets, Inc.
params:
author:
email: jdoe@example.org
name: John Doe
copyright = '© 2023 ABC Widgets, Inc.'
[params]
[params.author]
email = 'jdoe@example.org'
name = 'John Doe'
{
"copyright": "© 2023 ABC Widgets, Inc.",
"params": {
"author": {
"email": "jdoe@example.org",
"name": "John Doe"
}
}
}
包含订阅引用
要在渲染页面的 head
元素中包含订阅引用,请将以下内容放置在模板的 head
元素内:
{{ with .OutputFormats.Get "rss" -}}
{{ printf `<link rel=%q type=%q href=%q title=%q>` .Rel .MediaType.Type .Permalink site.Title | safeHTML }}
{{ end }}
Hugo 将将其渲染为:
<link rel="alternate" type="application/rss+xml" href="https://example.org/index.xml" title="ABC Widgets">
自定义模板
通过创建一个或多个符合命名约定的自定义模板,覆盖 Hugo 的内置 RSS 模板。
例如,要为主页、部分、分类和术语页面使用不同的模板:
layouts/
└── _default/
├── home.rss.xml
├── section.rss.xml
├── taxonomy.rss.xml
└── term.rss.xml
RSS 模板在上下文中接收 .Page
和 .Site
对象。
模板查找顺序
下表显示了各种页面种类的 RSS 模板查找顺序。第一个列表显示了在使用主题(demoTheme
)时的查找顺序。
示例 | OutputFormat | 后缀 | 模板查找顺序 |
---|---|---|---|
rss |
|
||
rss |
|
||
rss |
|
||
rss |
|