自定义Hugo的RSS模板

Apr 24, 2020
4分钟阅读时长

Hugo在生成网站时会默认为用户生成对应的RSS文件,然而Hugo默认生成的RSS订阅源中包含文章的全部内容。虽然这样能极大程度上得给用户提供便捷,但同时会增加文章被爬虫盗取导致版权问题的风险。

因此本文的主要内容是介绍如何自定义Hugo的RSS模板。

RSS简介

RSS全称为Really Simple Syndication,是一种简单易用的为用户提供信息聚合方式的规范。其语法相对简单且受到的支持较为广泛,因此非常适合于博客、新闻等网站。

RSS的语法在此就不再赘述,想要具体了解的读者可以查看我的另一篇文章RSS语法简介

Hugo默认的RSS模板

根据每个人选择的主题的不同,RSS代码可能略有不同,但殊途同归一通百通。

我目前使用的是Academic主题,Academic主题中的RSS模板位于themes/academic/layouts/_default/rss.xml,模板内容如下所示:

{{- /* Generate RSS v2 with full page content. */ -}}
{{- /* Upstream Hugo bug - RSS dates can be in future: https://github.com/gohugoio/hugo/issues/3918 */ -}}
{{- $page_context := cond .IsHome site . -}}
{{- $pages := $page_context.RegularPages -}}
{{- $limit := site.Config.Services.RSS.Limit -}}
{{- if ge $limit 1 -}}
  {{- $pages = $pages | first $limit -}}
{{- end -}}
{{- printf "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\" ?>" | safeHTML }}
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <title>{{ if ne .Title site.Title }}{{ with .Title }}{{.}} | {{ end }}{{end}}{{ site.Title }}</title>
    <link>{{ .Permalink }}</link>
    {{- with .OutputFormats.Get "RSS" }}
      {{ printf "<atom:link href=%q rel=\"self\" type=%q />" .Permalink .MediaType | safeHTML }}
    {{ end -}}
    <description>{{ .Title | default site.Title }}</description>
    <generator>Source Themes Academic (https://sourcethemes.com/academic/)</generator>
    {{- with site.LanguageCode }}<language>{{.}}</language>{{end -}}
    {{- with site.Copyright }}<copyright>{{ replace (replace . "{year}" now.Year) "&copy;" "©" | plainify }}</copyright>{{end -}}
    {{- if not .Date.IsZero }}<lastBuildDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</lastBuildDate>{{ end -}}
    {{- if .Scratch.Get "og_image" }}
    <image>
      <url>{{ .Scratch.Get "og_image" }}</url>
      <title>{{ .Title | default site.Title }}</title>
      <link>{{ .Permalink }}</link>
    </image>
    {{end -}}
    {{ range $pages }}
    <item>
      <title>{{ .Title }}</title>
      <link>{{ .Permalink }}</link>
      <pubDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</pubDate>
      <guid>{{ .Permalink }}</guid>
      <description>{{ .Content | html }}</description>
    </item>
    {{ end }}
  </channel>
</rss>

可以看到其中就是较为清晰明了的RSS文件格式。为了防止爬虫通过RSS盗取文章内容,我希望将RSS中的正文替换为摘要部分,并为读者增加跳转到原文的链接。

RSS模板的修改

自定义模板的路径

在Hugo官网上我们可以了解到Hugo在生成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]

因此我们只要在项目路径下的layouts/_default文件夹(如不存在该文件夹则按照路径创建即可)中新建一个rss.xml文件,并写入我们希望的模板即可。

编写自定义模板

通过对Academic默认RSS模板代码的阅读我们可以发现,在每一个<item>中,其<description>代码为:

<description>{{ .Content | html }}</description>

可以看到其默认状态下放入的为文章的内容,我们只需将.Content替换为.Summary即可只在RSS中加入摘要。

同时我们为了令读者能轻松便捷地阅读全文,还应加入一个阅读原文的链接。原文的链接可以通过.Permalink进行获取。

然而由于我的博客是一个双语博客,“阅读全文”的提示应该能根据语言进行变化,而不能仅仅将其写为字符串。好在Hugo支持多语言,因此我们可以通过此实现多语言提示。

在Academic主题默认的i18n文件中正好有id为more_pages的一项对应“查看全部”,因此可以直接在模板中使用这一项。在Hugo中只要使用{{i18n "more_pages"}}即可代表此处是id为more_pages的值。

综合以上多种修改,我们只需将

<description>{{ .Content | html }}</description>

改为

<description>{{ .Summary | html }}{{ printf "<br />" }}{{i18n "more_pages"}}: {{ .Permalink }}</description>

即可。

后记

RSS本应是一种为读者提供方便的信息聚合的方式。然而由于爬虫的泛滥,使得人们不得不对RSS的内容进行保护,也因此不得不在一定程度上损伤了读者的便利性。其中的平衡还需不断进行调整。

本文首发于我的个人博客技术公馆(wangchucheng.com)
原文链接:https://wangchucheng.com/zh/posts/hugo-rss-template/
本博客内文章除特别声明外均为原创,采用CC BY-NC-SA 4.0 许可协议进行许可。超出CC BY-NC-SA 4.0 许可协议的使用请联系作者获得授权。

Avatar
C. Wang 说学逗唱样样不精的地道天津人。