自定義Hugo的RSS模板

前言

Hugo在生成網站時會默認爲用戶生成對應的RSS文件，然而Hugo默認生成的RSS訂閱源中包含文章的所有內容。雖然這樣能極大程度上得給用戶提供便捷，但同時會增長文章被爬蟲盜取致使版權問題的風險。

所以本文的主要內容是介紹如何自定義Hugo的RSS模板。

本文首發於個人我的博客 技術公館(wcc.im)： 自定義Hugo的RSS模板

目錄

• 前言
• 目錄
• RSS簡介
• Hugo默認的RSS模板

• 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 許可協議的使用請聯繫做者得到受權。