Skip to content

Add built-in support for Open graph metadata #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
svendahlstrand wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Add built-in support for Open graph metadata #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9743a7e
Use .Site.Params.author for Hugo 0.158 compatibility.
svendahlstrand Apr 1, 2026
982806d
Make sure to plainify .Summary.
svendahlstrand Apr 1, 2026
2f18656
Unescape .Summary for Hugo 0.91 compatibility.
svendahlstrand Apr 1, 2026
ed40e1c
Add basic Open Graph metadata.
svendahlstrand May 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion layouts/_default/list.archivehtml.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
{{ if .Title }}
<span class="p-name"><b>{{ .Title }}</b></span>
{{ end }}
<span class="p-summary">{{ .Summary | truncate 100 }}</span>
<span class="p-summary">{{ .Summary | plainify | htmlUnescape | truncate 100 }}</span>
</p>

{{ end }}
Expand Down
2 changes: 1 addition & 1 deletion layouts/_default/list.json.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"version": "https://jsonfeed.org/version/1",
"title": {{ if eq .Title .Site.Title }}{{ .Site.Title | jsonify }}{{ else }}{{ printf `%s on %s` .Title .Site.Title | jsonify }}{{ end }},
"icon": "{{ .Site.Author.avatar }}",
"icon": "{{ .Site.Params.author.avatar }}",
"home_page_url": "{{ .Site.BaseURL }}",
"feed_url": "{{ .Site.BaseURL }}feed.json",
"items": [
Expand Down
2 changes: 1 addition & 1 deletion layouts/_default/rss.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<title>{{ .Title }}</title>
<link>{{ .Permalink }}</link>
<pubDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</pubDate>
{{ with .Site.Author.email }}<author>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</author>{{end}}
{{ with .Site.Params.author.email }}<author>{{.}}{{ with $.Site.Params.author.name }} ({{.}}){{end}}</author>{{end}}
{{- if .Params.guid }}
<guid>{{ .Params.guid }}</guid>
{{- else -}}
Expand Down
4 changes: 2 additions & 2 deletions layouts/index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"version": "https://jsonfeed.org/version/1",
"title": {{ .Site.Title | jsonify }},
"icon": "{{ .Site.Author.avatar }}",
"icon": "{{ .Site.Params.author.avatar }}",
"home_page_url": "{{ .Site.BaseURL }}",
"feed_url": "{{ .Site.BaseURL }}feed.json",
"items": [
Expand All @@ -22,7 +22,7 @@
{{- $s := replace $s "\\u003e" ">" -}}
{{- $s := replace $s "\\u0026" "&" }}
"content_html": {{ $s }},
{{ if .Params.custom_summary }}"summary": {{ .Summary | plainify | jsonify }},{{ end }}
{{ if .Params.custom_summary }}"summary": {{ .Summary | plainify | htmlUnescape | jsonify }},{{ end }}
"date_published": "{{ .Date.Format "2006-01-02T15:04:05-07:00" }}",
"url": "{{ .Permalink }}"
{{- with .Params.categories -}}
Expand Down
2 changes: 1 addition & 1 deletion layouts/index.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<title>{{ .Title }}</title>
<link>{{ .Permalink }}</link>
<pubDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</pubDate>
{{ with .Site.Author.email }}<author>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</author>{{end}}
{{ with .Site.Params.author.email }}<author>{{.}}{{ with $.Site.Params.author.name }} ({{.}}){{end}}</author>{{end}}
{{- if .Params.guid }}
<guid>{{ .Params.guid }}</guid>
{{- else -}}
Expand Down
2 changes: 1 addition & 1 deletion layouts/list.archivehtml.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
{{ if .Title }}
<span class="p-name"><b>{{ .Title }}</b></span>
{{ end }}
<span class="p-summary">{{ .Summary | truncate 100 }}</span>
<span class="p-summary">{{ .Summary | plainify | htmlUnescape | truncate 100 }}</span>
</p>

{{ end }}
Expand Down
4 changes: 2 additions & 2 deletions layouts/list.archivejson.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"version": "https://jsonfeed.org/version/1",
"title": {{ .Site.Title | jsonify }},
"icon": "{{ .Site.Author.avatar }}",
"icon": "{{ .Site.Params.author.avatar }}",
"home_page_url": "{{ .Site.BaseURL }}",
"feed_url": "{{ .Site.BaseURL }}photos/index.json",
"items": [
Expand All @@ -11,7 +11,7 @@
{
"id": "{{ .Permalink }}",
"title": {{ .Title | jsonify }},
"content_text": {{ .Summary | truncate 100 | jsonify }},
"content_text": {{ .Summary | plainify | htmlUnescape | truncate 100 | jsonify }},
"date_published": "{{ .Date.Format "2006-01-02T15:04:05-07:00" }}",
"url": "{{ .Permalink }}"
}
Expand Down
2 changes: 1 addition & 1 deletion layouts/list.photosjson.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"version": "https://jsonfeed.org/version/1",
"title": {{ .Site.Title | jsonify }},
"icon": "{{ .Site.Author.avatar }}",
"icon": "{{ .Site.Params.author.avatar }}",
"home_page_url": "{{ .Site.BaseURL }}",
"feed_url": "{{ .Site.BaseURL }}photos/index.json",
"items": [
Expand Down
2 changes: 1 addition & 1 deletion layouts/list.podcastjson.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"version": "https://jsonfeed.org/version/1",
"title": {{ .Site.Title | jsonify }},
"icon": "{{ .Site.Author.avatar }}",
"icon": "{{ .Site.Params.author.avatar }}",
"home_page_url": "{{ .Site.BaseURL }}",
"feed_url": "{{ .Site.BaseURL }}podcast.json",
"_podcast": {
Expand Down
2 changes: 1 addition & 1 deletion layouts/list.podcastxml.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<title>{{ .Title | htmlEscape }}</title>
<link>{{ .Permalink }}</link>
<pubDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</pubDate>
{{ with .Site.Author.email }}<author>{{ . | htmlEscape}}{{ with $.Site.Author.name }} ({{ . | htmlEscape}}){{end}}</author>{{end}}
{{ with .Site.Params.author.email }}<author>{{ . | htmlEscape}}{{ with $.Site.Params.author.name }} ({{ . | htmlEscape}}){{end}}</author>{{end}}
<guid isPermaLink="true">{{ .Permalink }}</guid>
<description><![CDATA[{{ .Content }}]]></description>
{{ range first 1 .Params.audio_with_metadata }}
Expand Down
2 changes: 1 addition & 1 deletion layouts/newsletter.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<div class="microblog_email">

<p class="microblog_header">
<img src="{{ .Site.Author.avatar }}" width="30" height="30" alt="Profile icon" style="border-radius: 15px; vertical-align: middle;">
<img src="{{ .Site.Params.author.avatar }}" width="30" height="30" alt="Profile icon" style="border-radius: 15px; vertical-align: middle;">
<b>{{ .Site.Title }}</b>
— <a href="{{ .Footer.UnsubscribeURL }}">Unsubscribe</a>

Expand Down
24 changes: 24 additions & 0 deletions layouts/partials/microblog_head.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,30 @@
<link rel="me" href="https://instagram.com/{{ . }}">
{{ end }}

{{ if .Site.Params.opengraph_is_enabled }}
{{ if .IsHome }}
<meta property="og:title" content="{{ .Site.Title }}">
<meta name="og:description" content="{{ .Site.Params.about_me | truncate 200 }}">
<meta property="og:image" content="{{ .Site.Params.author.avatar }}">
{{ else }}
<meta property="og:title" content="{{ with .Page.Title }}{{ . }}{{ else }}{{ delimit (split (.Summary | plainify) " " | first 5) " " }} …{{ end }}">
<meta name="og:description" content="{{ .Summary | truncate 200 }}">
{{ if .Params.photos }}
{{- range .Params.photos -}}
<meta property="og:image" content="{{ . }}">
{{- end -}}
{{ else }}
{{ with .Params.opengraph.image }}
<meta property="og:image" content="{{ . }}">
{{ end }}
{{ end }}
{{- end -}}

<meta property="og:type" content="{{ if .IsPage }}article{{ else }}website{{ end }}">
<meta property="og:url" content="{{ .Permalink }}">
<meta property="og:site_name" content="{{ .Site.Title }}">
{{ end }}

<link rel="shortcut icon" href="https://micro.blog/{{ .Site.Params.author.username }}/favicon.png" type="image/x-icon">
<link rel="EditURI" type="application/rsd+xml" href="{{ "rsd.xml" | absURL }}">
<link rel="authorization_endpoint" href="https://micro.blog/indieauth/auth">
Expand Down