自定义Hugo的RSS模板

前言

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

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

本文首发于我的个人博客技术公馆(wcc.im)自定义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的内容进行保护,也因此不得不在一定程度上损伤了读者的便利性。其中的平衡还需不断进行调整。

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,734评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,931评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,133评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,532评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,585评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,462评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,262评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,153评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,587评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,792评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,919评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,635评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,237评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,855评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,983评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,048评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,864评论 2 354