mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
tpl: Allow using page resources on the images page parameter for opengraph
, schema
and twitter_cards
templates
The page images selection order as follows: 1. Page's images parameter, image resources are supported. 2. Page's image resources that naming in *feature*, *cover* or *thumbnail* pattern. 3. If no page images specified, then the first one of site's images will be used as the fallback, supports site resources.
This commit is contained in:
parent
171836cdfa
commit
14d85ec136
6 changed files with 75 additions and 51 deletions
|
@ -36,9 +36,9 @@ lastmod: 2021-05-22T19:25:00-01:00
|
||||||
---
|
---
|
||||||
`)
|
`)
|
||||||
|
|
||||||
b.WithContent("mypage.md", `---
|
b.WithContent("mypage/index.md", `---
|
||||||
title: My Page
|
title: My Page
|
||||||
images: ["pageimg1.jpg", "pageimg2.jpg"]
|
images: ["pageimg1.jpg", "pageimg2.jpg", "https://example.local/logo.png", "sample.jpg"]
|
||||||
date: 2021-02-26T18:02:00+01:00
|
date: 2021-02-26T18:02:00+01:00
|
||||||
lastmod: 2021-05-22T19:25:00+01:00
|
lastmod: 2021-05-22T19:25:00+01:00
|
||||||
---
|
---
|
||||||
|
@ -58,37 +58,42 @@ title: My Site
|
||||||
`)
|
`)
|
||||||
|
|
||||||
b.WithSunset("content/mybundle/featured-sunset.jpg")
|
b.WithSunset("content/mybundle/featured-sunset.jpg")
|
||||||
|
b.WithSunset("content/mypage/sample.jpg")
|
||||||
b.Build(BuildCfg{})
|
b.Build(BuildCfg{})
|
||||||
|
|
||||||
b.AssertFileContent("public/mybundle/index.html", `
|
b.AssertFileContent("public/mybundle/index.html", `
|
||||||
<meta name="twitter:image" content="https://example.org/mybundle/featured-sunset.jpg"/>
|
<meta name="twitter:image" content="https://example.org/mybundle/featured-sunset.jpg" />
|
||||||
<meta name="twitter:title" content="My Bundle"/>
|
<meta name="twitter:title" content="My Bundle"/>
|
||||||
<meta property="og:title" content="My Bundle" />
|
<meta property="og:title" content="My Bundle" />
|
||||||
<meta property="og:url" content="https://example.org/mybundle/" />
|
<meta property="og:url" content="https://example.org/mybundle/" />
|
||||||
<meta property="og:image" content="https://example.org/mybundle/featured-sunset.jpg"/>
|
<meta property="og:image" content="https://example.org/mybundle/featured-sunset.jpg" />
|
||||||
<meta property="article:published_time" content="2021-02-26T18:02:00-01:00" />
|
<meta property="article:published_time" content="2021-02-26T18:02:00-01:00" />
|
||||||
<meta property="article:modified_time" content="2021-05-22T19:25:00-01:00" />
|
<meta property="article:modified_time" content="2021-05-22T19:25:00-01:00" />
|
||||||
<meta itemprop="name" content="My Bundle">
|
<meta itemprop="name" content="My Bundle">
|
||||||
<meta itemprop="image" content="https://example.org/mybundle/featured-sunset.jpg">
|
<meta itemprop="image" content="https://example.org/mybundle/featured-sunset.jpg" />
|
||||||
<meta itemprop="datePublished" content="2021-02-26T18:02:00-01:00" />
|
<meta itemprop="datePublished" content="2021-02-26T18:02:00-01:00" />
|
||||||
<meta itemprop="dateModified" content="2021-05-22T19:25:00-01:00" />
|
<meta itemprop="dateModified" content="2021-05-22T19:25:00-01:00" />
|
||||||
|
|
||||||
`)
|
`)
|
||||||
b.AssertFileContent("public/mypage/index.html", `
|
b.AssertFileContent("public/mypage/index.html", `
|
||||||
<meta name="twitter:image" content="https://example.org/pageimg1.jpg"/>
|
<meta name="twitter:image" content="https://example.org/pageimg1.jpg" />
|
||||||
<meta property="og:image" content="https://example.org/pageimg1.jpg" />
|
<meta property="og:image" content="https://example.org/pageimg1.jpg" />
|
||||||
<meta property="og:image" content="https://example.org/pageimg2.jpg" />
|
<meta property="og:image" content="https://example.org/pageimg2.jpg" />
|
||||||
|
<meta property="og:image" content="https://example.local/logo.png" />
|
||||||
|
<meta property="og:image" content="https://example.org/mypage/sample.jpg" />
|
||||||
<meta property="article:published_time" content="2021-02-26T18:02:00+01:00" />
|
<meta property="article:published_time" content="2021-02-26T18:02:00+01:00" />
|
||||||
<meta property="article:modified_time" content="2021-05-22T19:25:00+01:00" />
|
<meta property="article:modified_time" content="2021-05-22T19:25:00+01:00" />
|
||||||
<meta itemprop="image" content="https://example.org/pageimg1.jpg">
|
<meta itemprop="image" content="https://example.org/pageimg1.jpg" />
|
||||||
<meta itemprop="image" content="https://example.org/pageimg2.jpg">
|
<meta itemprop="image" content="https://example.org/pageimg2.jpg" />
|
||||||
|
<meta itemprop="image" content="https://example.local/logo.png" />
|
||||||
|
<meta itemprop="image" content="https://example.org/mypage/sample.jpg" />
|
||||||
<meta itemprop="datePublished" content="2021-02-26T18:02:00+01:00" />
|
<meta itemprop="datePublished" content="2021-02-26T18:02:00+01:00" />
|
||||||
<meta itemprop="dateModified" content="2021-05-22T19:25:00+01:00" />
|
<meta itemprop="dateModified" content="2021-05-22T19:25:00+01:00" />
|
||||||
`)
|
`)
|
||||||
b.AssertFileContent("public/mysite/index.html", `
|
b.AssertFileContent("public/mysite/index.html", `
|
||||||
<meta name="twitter:image" content="https://example.org/siteimg1.jpg"/>
|
<meta name="twitter:image" content="https://example.org/siteimg1.jpg" />
|
||||||
<meta property="og:image" content="https://example.org/siteimg1.jpg"/>
|
<meta property="og:image" content="https://example.org/siteimg1.jpg" />
|
||||||
<meta itemprop="image" content="https://example.org/siteimg1.jpg"/>
|
<meta itemprop="image" content="https://example.org/siteimg1.jpg" />
|
||||||
`)
|
`)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -3,17 +3,9 @@
|
||||||
<meta property="og:type" content="{{ if .IsPage }}article{{ else }}website{{ end }}" />
|
<meta property="og:type" content="{{ if .IsPage }}article{{ else }}website{{ end }}" />
|
||||||
<meta property="og:url" content="{{ .Permalink }}" />
|
<meta property="og:url" content="{{ .Permalink }}" />
|
||||||
|
|
||||||
{{- with $.Params.images -}}
|
{{- $images := partial "_funcs/get-page-images" . -}}
|
||||||
{{- range first 6 . }}<meta property="og:image" content="{{ . | absURL }}" />{{ end -}}
|
{{- range first 6 $images -}}
|
||||||
{{- else -}}
|
<meta property="og:image" content="{{ .Permalink }}" />
|
||||||
{{- $images := $.Resources.ByType "image" -}}
|
|
||||||
{{- $featured := $images.GetMatch "*feature*" -}}
|
|
||||||
{{- if not $featured }}{{ $featured = $images.GetMatch "{*cover*,*thumbnail*}" }}{{ end -}}
|
|
||||||
{{- with $featured -}}
|
|
||||||
<meta property="og:image" content="{{ $featured.Permalink }}"/>
|
|
||||||
{{- else -}}
|
|
||||||
{{- with $.Site.Params.images }}<meta property="og:image" content="{{ index . 0 | absURL }}"/>{{ end -}}
|
|
||||||
{{- end -}}
|
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
{{- if .IsPage }}
|
{{- if .IsPage }}
|
||||||
|
|
|
@ -0,0 +1,47 @@
|
||||||
|
{{- $imgs := slice }}
|
||||||
|
{{- $imgParams := .Params.images }}
|
||||||
|
{{- $resources := .Resources.ByType "image" -}}
|
||||||
|
{{/* Find featured image resources if the images parameter is empty. */}}
|
||||||
|
{{- if not $imgParams }}
|
||||||
|
{{- $featured := $resources.GetMatch "*feature*" -}}
|
||||||
|
{{- if not $featured }}{{ $featured = $resources.GetMatch "{*cover*,*thumbnail*}" }}{{ end -}}
|
||||||
|
{{- with $featured }}
|
||||||
|
{{- $imgs = $imgs | append (dict
|
||||||
|
"Image" .
|
||||||
|
"RelPermalink" .RelPermalink
|
||||||
|
"Permalink" .Permalink) }}
|
||||||
|
{{- end }}
|
||||||
|
{{- end }}
|
||||||
|
{{/* Use the first one of site images as the fallback. */}}
|
||||||
|
{{- if and (not $imgParams) (not $imgs) }}
|
||||||
|
{{- with site.Params.images }}
|
||||||
|
{{- $imgParams = first 1 . }}
|
||||||
|
{{- end }}
|
||||||
|
{{- end }}
|
||||||
|
{{/* Parse page's images parameter. */}}
|
||||||
|
{{- range $imgParams }}
|
||||||
|
{{- $img := . }}
|
||||||
|
{{- $url := urls.Parse $img }}
|
||||||
|
{{- if eq $url.Scheme "" }}
|
||||||
|
{{/* Internal image. */}}
|
||||||
|
{{- with $resources.GetMatch $img -}}
|
||||||
|
{{/* Image resource. */}}
|
||||||
|
{{- $imgs = $imgs | append (dict
|
||||||
|
"Image" .
|
||||||
|
"RelPermalink" .RelPermalink
|
||||||
|
"Permalink" .Permalink) }}
|
||||||
|
{{- else }}
|
||||||
|
{{- $imgs = $imgs | append (dict
|
||||||
|
"RelPermalink" (relURL $img)
|
||||||
|
"Permalink" (absURL $img)
|
||||||
|
) }}
|
||||||
|
{{- end }}
|
||||||
|
{{- else }}
|
||||||
|
{{/* External image */}}
|
||||||
|
{{- $imgs = $imgs | append (dict
|
||||||
|
"RelPermalink" $img
|
||||||
|
"Permalink" $img
|
||||||
|
) }}
|
||||||
|
{{- end }}
|
||||||
|
{{- end }}
|
||||||
|
{{- return $imgs }}
|
|
@ -7,17 +7,9 @@
|
||||||
{{ with .Lastmod }}<meta itemprop="dateModified" {{ .Format $iso8601 | printf "content=%q" | safeHTMLAttr }} />{{ end}}
|
{{ with .Lastmod }}<meta itemprop="dateModified" {{ .Format $iso8601 | printf "content=%q" | safeHTMLAttr }} />{{ end}}
|
||||||
<meta itemprop="wordCount" content="{{ .WordCount }}">
|
<meta itemprop="wordCount" content="{{ .WordCount }}">
|
||||||
|
|
||||||
{{- with $.Params.images -}}
|
{{- $images := partial "_funcs/get-page-images" . -}}
|
||||||
{{- range first 6 . -}}<meta itemprop="image" content="{{ . | absURL }}">{{ end -}}
|
{{- range first 6 $images -}}
|
||||||
{{- else -}}
|
<meta itemprop="image" content="{{ .Permalink }}" />
|
||||||
{{- $images := $.Resources.ByType "image" -}}
|
|
||||||
{{- $featured := $images.GetMatch "*feature*" -}}
|
|
||||||
{{- if not $featured }}{{ $featured = $images.GetMatch "{*cover*,*thumbnail*}" }}{{ end -}}
|
|
||||||
{{- with $featured -}}
|
|
||||||
<meta itemprop="image" content="{{ $featured.Permalink }}">
|
|
||||||
{{- else -}}
|
|
||||||
{{- with $.Site.Params.images -}}<meta itemprop="image" content="{{ index . 0 | absURL }}"/>{{ end -}}
|
|
||||||
{{- end -}}
|
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
<!-- Output all taxonomies as schema.org keywords -->
|
<!-- Output all taxonomies as schema.org keywords -->
|
||||||
|
|
|
@ -1,22 +1,10 @@
|
||||||
{{- with $.Params.images -}}
|
{{- $images := partial "_funcs/get-page-images" . -}}
|
||||||
<meta name="twitter:card" content="summary_large_image"/>
|
{{- with index $images 0 -}}
|
||||||
<meta name="twitter:image" content="{{ index . 0 | absURL }}"/>
|
<meta name="twitter:card" content="summary_large_image" />
|
||||||
{{ else -}}
|
<meta name="twitter:image" content="{{ .Permalink }}" />
|
||||||
{{- $images := $.Resources.ByType "image" -}}
|
|
||||||
{{- $featured := $images.GetMatch "*feature*" -}}
|
|
||||||
{{- if not $featured }}{{ $featured = $images.GetMatch "{*cover*,*thumbnail*}" }}{{ end -}}
|
|
||||||
{{- with $featured -}}
|
|
||||||
<meta name="twitter:card" content="summary_large_image"/>
|
|
||||||
<meta name="twitter:image" content="{{ $featured.Permalink }}"/>
|
|
||||||
{{- else -}}
|
{{- else -}}
|
||||||
{{- with $.Site.Params.images -}}
|
|
||||||
<meta name="twitter:card" content="summary_large_image"/>
|
|
||||||
<meta name="twitter:image" content="{{ index . 0 | absURL }}"/>
|
|
||||||
{{ else -}}
|
|
||||||
<meta name="twitter:card" content="summary"/>
|
<meta name="twitter:card" content="summary"/>
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
{{- end -}}
|
|
||||||
{{- end }}
|
|
||||||
<meta name="twitter:title" content="{{ .Title }}"/>
|
<meta name="twitter:title" content="{{ .Title }}"/>
|
||||||
<meta name="twitter:description" content="{{ with .Description }}{{ . }}{{ else }}{{if .IsPage}}{{ .Summary }}{{ else }}{{ with .Site.Params.description }}{{ . }}{{ end }}{{ end }}{{ end -}}"/>
|
<meta name="twitter:description" content="{{ with .Description }}{{ . }}{{ else }}{{if .IsPage}}{{ .Summary }}{{ else }}{{ with .Site.Params.description }}{{ . }}{{ end }}{{ end }}{{ end -}}"/>
|
||||||
|
|
||||||
|
|
|
@ -751,7 +751,7 @@ func (t *templateHandler) applyTemplateTransformers(ns *templateNamespace, ts *t
|
||||||
return c, err
|
return c, err
|
||||||
}
|
}
|
||||||
|
|
||||||
//go:embed embedded/templates/*
|
//go:embed all:embedded/templates/*
|
||||||
//go:embed embedded/templates/_default/*
|
//go:embed embedded/templates/_default/*
|
||||||
//go:embed embedded/templates/_server/*
|
//go:embed embedded/templates/_server/*
|
||||||
var embeddedTemplatesFs embed.FS
|
var embeddedTemplatesFs embed.FS
|
||||||
|
@ -779,7 +779,7 @@ func (t *templateHandler) loadEmbedded() error {
|
||||||
// For the render hooks and the server templates it does not make sense to preserve the
|
// For the render hooks and the server templates it does not make sense to preserve the
|
||||||
// double _internal double book-keeping,
|
// double _internal double book-keeping,
|
||||||
// just add it if its now provided by the user.
|
// just add it if its now provided by the user.
|
||||||
if !strings.Contains(path, "_default/_markup") && !strings.HasPrefix(name, "_server/") {
|
if !strings.Contains(path, "_default/_markup") && !strings.HasPrefix(name, "_server/") && !strings.HasPrefix(name, "partials/_funcs/") {
|
||||||
templateName = internalPathPrefix + name
|
templateName = internalPathPrefix + name
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue