前言
Hugo在生成網(wǎng)站時(shí)會默認(rèn)為用戶生成對應(yīng)的RSS文件乎澄,然而Hugo默認(rèn)生成的RSS訂閱源中包含文章的全部內(nèi)容害晦。雖然這樣能極大程度上得給用戶提供便捷骆膝,但同時(shí)會增加文章被爬蟲盜取導(dǎo)致版權(quán)問題的風(fēng)險(xiǎn)。
因此本文的主要內(nèi)容是介紹如何自定義Hugo的RSS模板即纲。
本文首發(fā)于我的個(gè)人博客技術(shù)公館(wcc.im):自定義Hugo的RSS模板
目錄
RSS簡介
RSS全稱為Really Simple Syndication具帮,是一種簡單易用的為用戶提供信息聚合方式的規(guī)范。其語法相對簡單且受到的支持較為廣泛低斋,因此非常適合于博客被丧、新聞等網(wǎng)站傅是。
RSS的語法在此就不再贅述齐苛,想要具體了解的讀者可以查看我的另一篇文章RSS語法簡介率寡。
Hugo默認(rèn)的RSS模板
根據(jù)每個(gè)人選擇的主題的不同翠语,RSS代碼可能略有不同整慎,但殊途同歸一通百通粱挡。
我目前使用的是Academic主題层坠,Academic主題中的RSS模板位于themes/academic/layouts/_default/rss.xml
衬衬,模板內(nèi)容如下所示:
{{- /* 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) "©" "?" | 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盜取文章內(nèi)容,我希望將RSS中的正文替換為摘要部分滋尉,并為讀者增加跳轉(zhuǎn)到原文的鏈接玉控。
RSS模板的修改
自定義模板的路徑
在Hugo官網(wǎng)上我們可以了解到Hugo在生成RSS文件時(shí)模板的查詢順序如下所示:
[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]
因此我們只要在項(xiàng)目路徑下的layouts/_default
文件夾(如不存在該文件夾則按照路徑創(chuàng)建即可)中新建一個(gè)rss.xml
文件,并寫入我們希望的模板即可狮惜。
編寫自定義模板
通過對Academic默認(rèn)RSS模板代碼的閱讀我們可以發(fā)現(xiàn)高诺,在每一個(gè)<item>
中碌识,其<description>
代碼為:
<description>{{ .Content | html }}</description>
可以看到其默認(rèn)狀態(tài)下放入的為文章的內(nèi)容,我們只需將.Content
替換為.Summary
即可只在RSS中加入摘要虱而。
同時(shí)我們?yōu)榱肆钭x者能輕松便捷地閱讀全文筏餐,還應(yīng)加入一個(gè)閱讀原文的鏈接。原文的鏈接可以通過.Permalink
進(jìn)行獲取牡拇。
然而由于我的博客是一個(gè)雙語博客魁瞪,“閱讀全文”的提示應(yīng)該能根據(jù)語言進(jìn)行變化,而不能僅僅將其寫為字符串惠呼。好在Hugo支持多語言导俘,因此我們可以通過此實(shí)現(xiàn)多語言提示。
在Academic主題默認(rèn)的i18n文件中正好有id為more_pages
的一項(xiàng)對應(yīng)“查看全部”罢杉,因此可以直接在模板中使用這一項(xiàng)趟畏。在Hugo中只要使用{{i18n "more_pages"}}
即可代表此處是id為more_pages
的值。
綜合以上多種修改滩租,我們只需將
<description>{{ .Content | html }}</description>
改為
<description>{{ .Summary | html }}{{ printf "<br />" }}{{i18n "more_pages"}}: {{ .Permalink }}</description>
即可赋秀。
后記
RSS本應(yīng)是一種為讀者提供方便的信息聚合的方式。然而由于爬蟲的泛濫律想,使得人們不得不對RSS的內(nèi)容進(jìn)行保護(hù)猎莲,也因此不得不在一定程度上損傷了讀者的便利性。其中的平衡還需不斷進(jìn)行調(diào)整技即。
本文首發(fā)于我的個(gè)人博客技術(shù)公館(wcc.im)著洼。
原文鏈接:https://wcc.im/zh/post/hugo-rss-template/
本博客內(nèi)文章除特別聲明外均為原創(chuàng),采用CC BY-NC-SA 4.0 許可協(xié)議進(jìn)行許可而叼。超出CC BY-NC-SA 4.0 許可協(xié)議的使用請聯(lián)系作者獲得授權(quán)身笤。