feat: add the json-ld module

hugomods · Mar 5, 2024 · 31e3553 · 31e3553
1 parent 023d91d
commit 31e3553
Show file tree

Hide file tree

Showing 9 changed files with 49 additions and 0 deletions.
diff --git a/modules/json-ld/go.mod b/modules/json-ld/go.mod
@@ -0,0 +1,3 @@
+module github.com/hugomods/seo/modules/json-ld
+
+go 1.18
diff --git a/modules/json-ld/hugo.toml b/modules/json-ld/hugo.toml
@@ -0,0 +1,3 @@
+[params.hugopress.modules.seo-json-ld.hooks.head-begin]
+
+[params.hugopress.modules.seo-json-ld.hooks.body-end]
diff --git a/modules/json-ld/layouts/partials/hugopress/modules/seo-json-ld/hooks/body-end.html b/modules/json-ld/layouts/partials/hugopress/modules/seo-json-ld/hooks/body-end.html
@@ -0,0 +1 @@
+{{- partial "seo/modules/json-ld/script" .Page -}}
diff --git a/modules/json-ld/layouts/partials/hugopress/modules/seo-json-ld/hooks/head-begin.html b/modules/json-ld/layouts/partials/hugopress/modules/seo-json-ld/hooks/head-begin.html
@@ -0,0 +1 @@
+{{- partial "seo/modules/json-ld/index" .Page -}}
diff --git a/modules/json-ld/layouts/partials/seo/modules/json-ld/append.html b/modules/json-ld/layouts/partials/seo/modules/json-ld/append.html
@@ -0,0 +1,3 @@
+{{- $page := .page }}
+{{- $structure := partial (printf "seo/modules/json-ld/structures/%s" .structure) $page }}
+{{- $page.Store.SetInMap "seo-json-ld" (index $structure "@type") $structure }}
diff --git a/modules/json-ld/layouts/partials/seo/modules/json-ld/index.html b/modules/json-ld/layouts/partials/seo/modules/json-ld/index.html
@@ -0,0 +1,10 @@
+{{- if .IsHome }}
+  {{- partial "seo/modules/json-ld/append" (dict "page" . "structure" "website") }}
+{{- end }}
+{{- $params := default dict .Params.json_ld }}
+{{- $structures := slice "news-article" }}
+{{- range $structures }}
+  {{- if isset $params . }}
+    {{- partial "seo/modules/json-ld/append" (dict "page" . "structure" .) }}
+  {{- end }}
+{{- end }}
diff --git a/modules/json-ld/layouts/partials/seo/modules/json-ld/script.html b/modules/json-ld/layouts/partials/seo/modules/json-ld/script.html
@@ -0,0 +1,9 @@
+{{- with .Store.Get "seo-json-ld" }}
+  {{- $json := . }}
+  {{- if eq (len .) 1 }}
+    {{- $json = jsonify (index (sort .) 0) }}
+  {{- else }}
+    {{- $json = jsonify . }}
+  {{- end }}
+  {{- $json | printf `<script type="application/ld+json">%s</script>` | safeHTML }}
+{{- end -}}
diff --git a/modules/json-ld/layouts/partials/seo/modules/json-ld/structures/news-article.html b/modules/json-ld/layouts/partials/seo/modules/json-ld/structures/news-article.html
@@ -0,0 +1,13 @@
+{{- $s := newScratch }}
+{{- $s.Set "@context" "https://schema.org" }}
+{{- $s.Set "@type" "NewsArticle" }}
+{{- $s.Set "headline" .Title }}
+{{- $s.Set "datePublished" .Date }}
+{{- with .Lastmod }}
+  {{- $s.Set "dateModified" . }}
+{{- end }}
+{{- range partial "_funcs/get-page-images" . }}
+  {{- $s.Add "image" (slice .Permalink) }}
+{{- end }}
+{{/* TODO: author */}}
+{{- return $s.Values }}
diff --git a/modules/json-ld/layouts/partials/seo/modules/json-ld/structures/website.html b/modules/json-ld/layouts/partials/seo/modules/json-ld/structures/website.html
@@ -0,0 +1,6 @@
+{{- return dict
+  "@context" "https://schema.org"
+  "@type" "WebSite"
+  "name" (default site.Title site.Params.seo.json_ld.website.name)
+  "url" site.Home.Permalink
+}}