下面會修改到 Hugo 設定，還不知道怎麼改設定檔建議先看 Hugo 設定檔 的說明
hugo 預設生成的RSS檔案在 localhost:1313/index.xml
如果要取代原本的RSS檔名，可以直接改 hugo.toml
將 outputFormats.RSS 的 baseName 改成想要的檔名
設定檔中沒有這段的話，可以直接貼上下面的設定
這邊只紀錄 toml 格式的設定方式，需要 yaml 或 json 格式，請參考官方文件 Custom output formats
1
2
3
4
|
[outputFormats]
[outputFormats.RSS]
mediatype = "application/rss+xml"
baseName = "rss"
|
這樣就可以把RSS的檔名改成 localhost:1313/rss.xml
自定輸出類型
這種方式適合用在同時加 RSS、ATOM、JSON Feed 或其他的自訂格式
這邊以建立 Atom feed 作為範例
1
2
3
4
5
6
7
8
9
10
|
[outputs]
home = ["HTML"]
section = ['HTML','ATOM']
taxonomy = ['HTML']
term = ['HTML']
[outputFormats]
[outputFormats.ATOM]
mediatype = "application/rss+xml"
baseName = "atom"
|
中間的mediatype就可以照我們的需要調整，Atom 跟 RSS 相同即可
如果是 JSON Feed ，就可以改為 application/json
其他內建的輸出格式可參考 Output format definitions
需要生成 ATOM Feed 的部分，就可以在 outputs 後面加上我們自訂的 ATOM
像我這就只需要 section 生成 ATOM Feed
如果沒有特別設定的話，這四種類的 output 預設都是 [“HTML”,“RSS”]
到這邊我們的 ATOM Feed 還沒設定完，還需要新增模版
建模版檔案
我們可以在 layout 資料夾內建立模版檔案，覆蓋預設的模版
layouts/
└── _default/
├── home.atom.xml
├── section.atom.xml
├── taxonomy.atom.xml
└── term.atom.xml
如果不想細分這麼詳細，全部都是套用同一個模版，可以只新增 layouts/_default/list.atom.xml
詳細的檔名批配機制可以參考官方文件 lookup-order/#rss-templates
模版內容
這邊我使用 araname/atom-template-for-hugo 的模版
Allows Hugo to generate Atom feeds to your site
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
{{- /* Deprecate site.Author.email in favor of site.Params.author.email */}}
{{- $authorEmail := "" }}
{{- with site.Params.author }}
{{- if reflect.IsMap . }}
{{- with .email }}
{{- $authorEmail = . }}
{{- end }}
{{- end }}
{{- else }}
{{- with site.Author.email }}
{{- $authorEmail = . }}
{{- warnf "The author key in site configuration is deprecated. Use params.author.email instead." }}
{{- end }}
{{- end }}
{{- /* Deprecate site.Author.name in favor of site.Params.author.name */}}
{{- $authorName := "" }}
{{- with site.Params.author }}
{{- if reflect.IsMap . }}
{{- with .name }}
{{- $authorName = . }}
{{- end }}
{{- else }}
{{- $authorName = . }}
{{- end }}
{{- else }}
{{- with site.Author.name }}
{{- $authorName = . }}
{{- warnf "The author key in site configuration is deprecated. Use params.author.name instead." }}
{{- end }}
{{- end }}
{{- $pctx := . }}
{{- if .IsHome }}{{ $pctx = .Site }}{{ end }}
{{- $pages := slice }}
{{- if or $.IsHome $.IsSection }}
{{- $pages = $pctx.RegularPages }}
{{- else }}
{{- $pages = $pctx.Pages }}
{{- end }}
{{- $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 }}
<feed xmlns="http://www.w3.org/2005/Atom" xml:lang="{{ site.Language.LanguageCode }}">
<title>{{ if eq .Title .Site.Title }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{ . }} on {{ end }}{{ .Site.Title }}{{ end }}</title>
<link href="{{ .Permalink }}" />
<subtitle>Recent content {{ if ne .Title .Site.Title }}{{ with .Title }}in {{ . }} {{ end }}{{ end }}on {{ .Site.Title }}</subtitle>
<generator>Hugo</generator>
{{- if or $authorName $authorEmail }}
<author>{{ end }}{{ with $authorName }}
<name>{{ . }}</name>{{ end }}{{ with $authorEmail }}
<email>{{ . }}</email>{{ end }}{{ if or $authorName $authorEmail }}
</author>{{ end }}{{ with .Site.Copyright }}
<rights>{{ . }}</rights>{{ end }}{{ if not .Date.IsZero }}
<updated>{{ (index $pages.ByLastmod.Reverse 0).Lastmod.Format "2006-01-02T15:04:05-07:00" | safeHTML }}</updated>{{ end }}
{{- with .OutputFormats.Get "Atom" }}
{{ printf "<link href=%q rel=\"self\" type=%q />" .Permalink .MediaType | safeHTML }}
{{- end }}
<id>{{ .Permalink }}</id>
{{- range $pages }}
<entry>
<title>{{ .Title }}</title>
<link href="{{ .Permalink }}" />
<published>{{ .PublishDate.Format "2006-01-02T15:04:05-07:00" | safeHTML }}</published>
<updated>{{ .Lastmod.Format "2006-01-02T15:04:05-07:00" | safeHTML }}</updated>
{{- if or $authorName $authorEmail }}
<author>{{ end }}{{ with $authorName }}
<name>{{ . }}</name>{{ end }}{{ with $authorEmail }}
<email>{{ . }}</email>{{ end }}{{ if or $authorName $authorEmail }}
</author>{{ end }}
<id>{{ .Permalink }}</id>
<content type="html">{{ .Content | transform.XMLEscape | safeHTML }}</content>
</entry>
{{- end }}
</feed>
|
完成之後，Hugo 就會幫我們生成對應的 atom.xml 檔了
修改檔案位置
有些網站的 RSS 可能不放在根目錄，例如 localhost:1313/rss/rss.xml
有這樣的需求，目前 Hugo 沒有比較好的方式能直接生成在指定位置
可以在 Hugo 轉譯完之後，另外用指令去移動
1
|
mv public/rss.xml public/rss/rss.xml
|
本站的 Rss 設定時有碰一個小問題
我不想要左邊選單的頁面(page)被列在 RSS 裡面，只需要有貼文(post)就好
位在 public/post/rss.xml 這個檔案，剛好就只有貼文的資料
所以乾脆就在 CICD 的設定內，加上複製檔案蓋掉根目錄的 rss.xml
1
2
3
4
5
6
7
8
9
10
|
when:
- event: push
branch: main
steps:
- name: build
image: hugomods/hugo:dart-sass-go-git
commands:
- hugo build
- cp public/post/rss.xml public/rss.xml
|
參考來源
