MENU

Hugo RSS 模板修改

May 1, 2019 • 笔记•记录

本文若有失效或者错误内容请留言或者通过其他方式联系我,尽可能及时更新。

欢迎关注不怎么更新的 TG 频道


前言

之前博客的 RSS 一直用的是 Hugo 自带的模板,以前我也没看过具体效果,昨天心血来潮用了下 Inoreader,订阅了自己的 RSS 试了下,发现没有抓取全文,只是显示了一个摘要,如果需要全文还要自己去点击下,这样感觉有点麻烦了(如果能有朋友愿意订阅我的垃圾博客,我希望能给他们最好的体验,哈哈),然后查看了 Hugo 的官方文档,自己稍微动手改了改,做下记录水一篇文章。 :stuck_out_tongue_closed_eyes:

修改 RSS 模板

从官方文档关于 RSS Templates 的叙述中了解到:

  1. Hugo 默认的 RSS 模板;
  2. RSS 模板的查询顺序。

home RSS 为例,查询顺序如下:

[layouts/index.rss.xml 
layouts/home.rss.xml 
layouts/rss.xml 
layouts/list.rss.xml 
layouts/index.xml 
layouts/home.xml 
layouts/list.xml 
layouts/_default/index.rss.xml 
layouts/_default/home.rss.xml 
layouts/_default/rss.xml 
layouts/_default/list.rss.xml 
layouts/_default/index.xml 
layouts/_default/home.xml 
layouts/_default/list.xml 
layouts/_internal/_default/rss.xml]

可以看到,Hugo 自带的模板都是处于最后使用的,其实不管是 home 还是 section 抑或是 taxonomy 都是这样的,因此,只要在合适的位置放上一个 RSS 模板就可以了。

自带 RSS 模板如下:

<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
  <title>{{ if eq  .Title  .Site.Title }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{.}} on {{ end }}{{ .Site.Title }}{{ end }}</title>
  <link>{{ .Permalink }}</link>
  <description>Recent content {{ if ne  .Title  .Site.Title }}{{ with .Title }}in {{.}} {{ end }}{{ 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 }}
  {{ with .OutputFormats.Get "RSS" }}
      {{ printf "<atom:link href=%q rel=\"self\" type=%q />" .Permalink .MediaType | safeHTML }}
  {{ end }}
  {{ range .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>{{ .Summary | html }}</description>
  </item>
  {{ end }}
</channel>
</rss>

<description>{{ .Summary | html }}</description>这行可以看到该模板只显示概要的原因了,那么我们只需要将其更改为<description>{{ .Content | html }}</description>就解决了。

因为我准备博客中所有的 RSS 订阅都使用同一个模板,所以直接在layouts/_default/下创建了一个rss.xml文件(开始脑子抽了,居然想在每个 RSS 订阅下添加一个模板,怕不是要累死),内容如下:

<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
  <title>{{ if eq  .Title  .Site.Title }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{.}} on {{ end }}{{ .Site.Title }}{{ end }}</title>
  <link>{{ .Permalink }}</link>
  <description>Recent content {{ if ne  .Title  .Site.Title }}{{ with .Title }}in {{.}} {{ end }}{{ 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 }}
  {{ with .OutputFormats.Get "RSS" }}
      {{ printf "<atom:link href=%q rel=\"self\" type=%q />" .Permalink .MediaType | safeHTML }}
  {{ end }}
  {{ range first 10 (where .Data.Pages ".Params.enrypt" "!=" "true") }}
  <item>
    <title>{{ .Title }}</title>
    <link>{{ .Permalink }}</link>
    <pubDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</pubDate>
    {{ with .Params.author }}<author> {{.}} </author>{{end}}
    <guid>{{ .Permalink }}</guid>
    <description>{{ .Content | html }}</description>
  </item>
  {{ end }}
</channel>
</rss>

主要的修改有以下三行:

<!-- 默认抓取前十篇不包含加密文章的内容 -->
{{ range first 10 (where .Data.Pages ".Params.enrypt" "!=" "true") }}
<!-- 作者采用文章作者而不是网站默认作者 -->
{{ with .Params.author }}<author> {{.}} </author>{{end}}
<!-- 默认输出全文 -->
<description>{{ .Content | html }}</description>

配置 RSS

根据 RSS 模板内容,我们可以在 config.toml 文件中定义一些内容,例如:

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

[author]
    name = "WithdewHua"
    email = "i@withdewhua.space"

本文链接:https://withdewhua.space/2019/05/01/hugo-rss
本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可,转载请注明出处。

Last Modified: October 8, 2019
Archives QR Code Tip
QR Code for this page
Tipping QR Code