自定義Hugo的RSS模板

前言

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) "&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盜取文章內(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)身笤。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市葵陵,隨后出現(xiàn)的幾起案子液荸,更是在濱河造成了極大的恐慌,老刑警劉巖脱篙,帶你破解...
    沈念sama閱讀 211,817評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件娇钱,死亡現(xiàn)場離奇詭異,居然都是意外死亡绊困,警方通過查閱死者的電腦和手機(jī)文搂,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,329評論 3 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來秤朗,“玉大人煤蹭,你說我怎么就攤上這事。” “怎么了疯兼?”我有些...
    開封第一講書人閱讀 157,354評論 0 348
  • 文/不壞的土叔 我叫張陵然遏,是天一觀的道長。 經(jīng)常有香客問我吧彪,道長待侵,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,498評論 1 284
  • 正文 為了忘掉前任姨裸,我火速辦了婚禮秧倾,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘傀缩。我一直安慰自己那先,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,600評論 6 386
  • 文/花漫 我一把揭開白布赡艰。 她就那樣靜靜地躺著售淡,像睡著了一般。 火紅的嫁衣襯著肌膚如雪慷垮。 梳的紋絲不亂的頭發(fā)上揖闸,一...
    開封第一講書人閱讀 49,829評論 1 290
  • 那天,我揣著相機(jī)與錄音料身,去河邊找鬼汤纸。 笑死,一個(gè)胖子當(dāng)著我的面吹牛芹血,可吹牛的內(nèi)容都是我干的贮泞。 我是一名探鬼主播,決...
    沈念sama閱讀 38,979評論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼幔烛,長吁一口氣:“原來是場噩夢啊……” “哼啃擦!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起饿悬,我...
    開封第一講書人閱讀 37,722評論 0 266
  • 序言:老撾萬榮一對情侶失蹤议惰,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后乡恕,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,189評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡俯萎,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,519評論 2 327
  • 正文 我和宋清朗相戀三年傲宜,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片夫啊。...
    茶點(diǎn)故事閱讀 38,654評論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡函卒,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出撇眯,到底是詐尸還是另有隱情报嵌,我是刑警寧澤虱咧,帶...
    沈念sama閱讀 34,329評論 4 330
  • 正文 年R本政府宣布,位于F島的核電站锚国,受9級特大地震影響腕巡,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜血筑,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,940評論 3 313
  • 文/蒙蒙 一绘沉、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧豺总,春花似錦车伞、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,762評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至表伦,卻和暖如春谦去,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背绑榴。 一陣腳步聲響...
    開封第一講書人閱讀 31,993評論 1 266
  • 我被黑心中介騙來泰國打工哪轿, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人翔怎。 一個(gè)月前我還...
    沈念sama閱讀 46,382評論 2 360
  • 正文 我出身青樓窃诉,卻偏偏與公主長得像,于是被迫代替她去往敵國和親赤套。 傳聞我的和親對象是個(gè)殘疾皇子飘痛,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,543評論 2 349