From 294878874ad5a32a2bcc90e0b7319de4f510781d Mon Sep 17 00:00:00 2001
From: drkhsh <me@drkhsh.at>
Date: Sun, 19 Jan 2025 00:55:24 +0100
Subject: [PATCH] add atom feed
---
go.mod | 5 ++
go.sum | 2 +
hugo.toml | 24 +++++--
layouts/_default/list.atom.xml | 120 +++++++++++++++++++++++++++++++++
4 files changed, 144 insertions(+), 7 deletions(-)
create mode 100644 go.mod
create mode 100644 go.sum
create mode 100644 layouts/_default/list.atom.xml
diff --git a/go.mod b/go.mod
new file mode 100644
index 0000000..0229cd5
--- /dev/null
+++ b/go.mod
@@ -0,0 +1,5 @@
+module git.it-syndikat.org/IT-Syndikat/website
+
+go 1.23.5
+
+require github.com/kaushalmodi/hugo-atom-feed v0.2.0 // indirect
diff --git a/go.sum b/go.sum
new file mode 100644
index 0000000..3bdb64c
--- /dev/null
+++ b/go.sum
@@ -0,0 +1,2 @@
+github.com/kaushalmodi/hugo-atom-feed v0.2.0 h1:7jeUfQTBal7SjcAR0fPMKIsfMXb8OLoTo1BPMkLO1vQ=
+github.com/kaushalmodi/hugo-atom-feed v0.2.0/go.mod h1:eNCxNrqVpeR5IvtTrAB1J8ruthtI3KtHMlOIwp0rafo=
diff --git a/hugo.toml b/hugo.toml
index 1c8c530..a9dea2f 100644
--- a/hugo.toml
+++ b/hugo.toml
@@ -62,6 +62,12 @@ pluralizelisttitles = false # removes the automatically appended "s" on sideba
cached = false # activate cache if true
email = "wir@it-syndikat.org"
+[[Params.widgets.social.custom]]
+ title = "Mastodon"
+ url = "https://chaos.social/@itsyndikat"
+ icon = "mastodon.svg" # Optional. Path relative to "layouts/partials"
+ rel = "noopener noreferrer" # Set to false to remove the rel attribute
+
[[Params.widgets.social.custom]]
title = "RSS Feed"
url = "/index.xml"
@@ -69,9 +75,9 @@ pluralizelisttitles = false # removes the automatically appended "s" on sideba
rel = "noopener noreferrer" # Set to false to remove the rel attribute
[[Params.widgets.social.custom]]
- title = "Mastodon"
- url = "https://chaos.social/@itsyndikat"
- icon = "mastodon.svg" # Optional. Path relative to "layouts/partials"
+ title = "Atom Feed"
+ url = "/atom.xml"
+ icon = "rss.svg" # Optional. Path relative to "layouts/partials"
rel = "noopener noreferrer" # Set to false to remove the rel attribute
[Params.widgets.sensors]
@@ -108,8 +114,12 @@ pluralizelisttitles = false # removes the automatically appended "s" on sideba
[params.meta]
favicon = false
+[module]
+ [[module.imports]]
+ path = "github.com/kaushalmodi/hugo-atom-feed"
+
[outputs]
- home = ['html', 'rss']
- section = ['html', 'rss']
- taxonomy = ['html']
- term = ['html']
+ home = ['html', 'rss', 'atom']
+ section = ['html', 'rss', 'atom']
+ taxonomy = ['html', 'rss', 'atom']
+ term = ['html', 'rss', 'atom']
diff --git a/layouts/_default/list.atom.xml b/layouts/_default/list.atom.xml
new file mode 100644
index 0000000..6489315
--- /dev/null
+++ b/layouts/_default/list.atom.xml
@@ -0,0 +1,120 @@
+{{ printf `<?xml version="1.0" encoding="utf-8"?>` | safeHTML }} {{/* ref: https://validator.w3.org/feed/docs/atom.html */}}
+<feed xmlns="http://www.w3.org/2005/Atom"{{ with site.LanguageCode }} xml:lang="{{ . }}"{{ end }}>
+ <generator uri="https://gohugo.io/" version="{{ hugo.Version }}">Hugo</generator>
+ {{- $title := site.Title -}}
+ {{- with .Title -}}
+ {{- if (not (eq . site.Title)) -}}
+ {{- $title = printf `%s %s %s` . (i18n "feed_title_on" | default "on") site.Title -}}
+ {{- end -}}
+ {{- end -}}
+ {{- if .IsTranslated -}}
+ {{ $title = printf "%s (%s)" $title (index site.Data.i18n.languages .Lang) }}
+ {{- end -}}
+ {{ printf `<title type="html"><![CDATA[%s]]></title>` $title | safeHTML }}
+ {{ with (or (.Param "subtitle") (.Param "tagline")) }}
+ {{ printf `<subtitle type="html"><![CDATA[%s]]></subtitle>` . | safeHTML }}
+ {{ end }}
+ {{ $output_formats := .OutputFormats }}
+ {{ range $output_formats -}}
+ {{- $rel := (or (and (eq "atom" (.Name | lower)) "self") "alternate") -}}
+ {{ with $output_formats.Get .Name }}
+ {{ printf `<link href=%q rel=%q type=%q title=%q />` .Permalink $rel .MediaType.Type .Name | safeHTML }}
+ {{- end -}}
+ {{- end }}
+ {{- range .Translations }}
+ {{ $output_formats := .OutputFormats }}
+ {{- $lang := .Lang }}
+ {{- $langstr := index site.Data.i18n.languages .Lang }}
+ {{ range $output_formats -}}
+ {{ with $output_formats.Get .Name }}
+ {{ printf `<link href=%q rel="alternate" type=%q hreflang=%q title="[%s] %s" />` .Permalink .MediaType.Type $lang $langstr .Name | safeHTML }}
+ {{- end -}}
+ {{- end }}
+ {{- end }}
+ <updated>{{ now.Format "2006-01-02T15:04:05-07:00" | safeHTML }}</updated>
+ {{ with site.Copyright }}
+ {{- $copyright := replace . "{year}" now.Year -}} {{/* In case the site.copyright uses a special string "{year}" */}}
+ {{- $copyright = replace $copyright "©" "©" -}}
+ <rights>{{ $copyright | plainify }}</rights>
+ {{- end }}
+ {{ with .Param "feed" }}
+ {{/* For this to work, the $icon file should be present in the assets/ directory */}}
+ {{- $icon := .icon | default "icon.svg" -}}
+ {{- with resources.Get $icon -}}
+ <icon>{{ (. | fingerprint).Permalink }}</icon>
+ {{- end }}
+
+ {{/* For this to work, the $logo file should be present in the assets/ directory */}}
+ {{- $logo := .logo | default "logo.svg" -}}
+ {{- with resources.Get $logo -}}
+ <logo>{{ (. | fingerprint).Permalink }}</logo>
+ {{- end }}
+ {{ end }}
+ {{ with site.Author.name -}}
+ <author>
+ <name>{{ . }}</name>
+ {{ with site.Author.email }}
+ <email>{{ . }}</email>
+ {{ end -}}
+ </author>
+ {{- end }}
+ {{ with site.Params.id }}
+ <id>{{ . | plainify }}</id>
+ {{ else }}
+ <id>{{ .Permalink }}</id>
+ {{ end }}
+ {{- $limit := (cond (le site.Config.Services.RSS.Limit 0) 65536 site.Config.Services.RSS.Limit) }}
+ {{- $feed_sections := site.Params.feedSections | default site.Params.mainSections -}}
+ {{/* Range through only the pages with a Type in $feed_sections. */}}
+ {{- $pages := where .RegularPages "Type" "in" $feed_sections -}}
+ {{- if (eq .Kind "home") -}}
+ {{- $pages = where site.RegularPages "Type" "in" $feed_sections -}}
+ {{- end -}}
+ {{/* Remove the pages that have the disable_feed parameter set to true. */}}
+ {{- $pages = where $pages ".Params.disable_feed" "!=" true -}}
+ {{/* Remove the pages that have the unlisted parameter set to true. */}}
+ {{- $pages = where $pages ".Params.unlisted" "!=" true -}}
+ {{- range first $limit $pages }}
+ {{ $page := . }}
+ <entry>
+ {{ printf `<title type="html"><![CDATA[%s]]></title>` .Title | safeHTML }}
+ <link href="{{ .Permalink }}?utm_source=atom_feed" rel="alternate" type="text/html" />
+ {{- range .Translations }}
+ {{- $link := printf "%s?utm_source=atom_feed" .Permalink | safeHTML }}
+ {{- printf `<link href=%q rel="alternate" type="text/html" hreflang=%q />` $link .Lang | safeHTML }}
+ {{- end }}
+ {{/* rel=related: See https://validator.w3.org/feed/docs/atom.html#link */}}
+ {{- range first 5 (site.RegularPages.Related .) }}
+ <link href="{{ .Permalink }}?utm_source=atom_feed" rel="related" type="text/html" title="{{ .Title }}" />
+ {{- end }}
+ {{ with .Params.id }}
+ <id>{{ . | plainify }}</id>
+ {{ else }}
+ <id>{{ .Permalink }}</id>
+ {{ end }}
+ {{ with .Params.Author -}}
+ <author>
+ <name>{{ . }}</name>
+ </author>
+ {{- end }}
+ <published>{{ .Date.Format "2006-01-02T15:04:05-07:00" | safeHTML }}</published>
+ <updated>{{ .Lastmod.Format "2006-01-02T15:04:05-07:00" | safeHTML }}</updated>
+ {{ $description1 := .Description | default "" }}
+ {{ $description := (cond (eq "" $description1) "" (printf "<blockquote>%s</blockquote>" ($description1 | markdownify))) }}
+ {{ printf `<content type="html"><![CDATA[%s%s]]></content>` $description .Content | safeHTML }}
+ {{ with site.Taxonomies }}
+ {{ range $taxo,$_ := . }} <!-- Defaults taxos: "tags", "categories" -->
+ {{ with $page.Param $taxo }}
+ {{ $taxo_list := . }} <!-- $taxo_list will be the tags/categories list -->
+ {{ with site.GetPage (printf "/%s" $taxo) }}
+ {{ $taxonomy_page := . }}
+ {{ range $taxo_list }} <!-- Below, assuming pretty URLs -->
+ <category scheme="taxonomy:{{ printf "%s" $taxo | humanize }}" term="{{ (. | urlize) }}" label="{{ . }}" />
+ {{ end }}
+ {{ end }}
+ {{ end }}
+ {{ end }}
+ {{ end }}
+ </entry>
+ {{ end }}
+</feed>