Internal templates
Google Analytics
Hugo ships with an internal template supporting Google Analytics 4 (GA4).
Note: Universal Analytics are deprecated.
Configure Google Analytics
Provide your tracking ID in your configuration file:
Google Analytics 4 (gtag.js)
services:
googleAnalytics:
ID: G-MEASUREMENT_ID
[services]
[services.googleAnalytics]
ID = 'G-MEASUREMENT_ID'
{
"services": {
"googleAnalytics": {
"ID": "G-MEASUREMENT_ID"
}
}
}
Use the Google Analytics template
Include the Google Analytics internal template in your templates where you want the code to appear:
{{ template "_internal/google_analytics.html" . }}
To create your own template, access the configured ID with {{ site.Config.Services.GoogleAnalytics.ID }}
.
Disqus
Hugo also ships with an internal template for Disqus comments, a popular commenting system for both static and dynamic websites. To effectively use Disqus, secure a Disqus “shortname” by signing up for the free service.
Configure Disqus
To use Hugo’s Disqus template, first set up a single configuration value:
services:
disqus:
shortname: your-disqus-shortname
[services]
[services.disqus]
shortname = 'your-disqus-shortname'
{
"services": {
"disqus": {
"shortname": "your-disqus-shortname"
}
}
}
Hugo’s Disqus template accesses this value with:
{{ .Site.Config.Services.Disqus.Shortname }}
You can also set the following in the front matter for a given piece of content:
disqus_identifier
disqus_title
disqus_url
Use the Disqus template
To add Disqus, include the following line in the templates where you want your comments to appear:
{{ template "_internal/disqus.html" . }}
Conditional loading of Disqus comments
Users have noticed that enabling Disqus comments when running the Hugo web server on localhost
(i.e. via hugo server
) causes the creation of unwanted discussions on the associated Disqus account.
You can create the following layouts/partials/disqus.html
:
<div id="disqus_thread"></div>
<script type="text/javascript">
(function() {
// Don't ever inject Disqus on localhost--it creates unwanted
// discussions from 'localhost:1313' on your Disqus account...
if (window.location.hostname == "localhost")
return;
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
var disqus_shortname = '{{ .Site.Config.Services.Disqus.Shortname }}';
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
<a href="https://disqus.com/" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
The if
statement skips the initialization of the Disqus comment injection when you are running on localhost
.
You can then render your custom Disqus partial template as follows:
{{ partial "disqus.html" . }}
Open Graph
An internal template for the Open Graph protocol, metadata that enables a page to become a rich object in a social graph. This format is used for Facebook and some other sites.
Configure Open Graph
Hugo’s Open Graph template is configured using a mix of configuration variables and front-matter on individual pages.
params:
description: Text about my cool site
images:
- site-feature-image.jpg
title: My cool site
taxonomies:
series: series
[params]
description = 'Text about my cool site'
images = ['site-feature-image.jpg']
title = 'My cool site'
[taxonomies]
series = 'series'
{
"params": {
"description": "Text about my cool site",
"images": [
"site-feature-image.jpg"
],
"title": "My cool site"
},
"taxonomies": {
"series": "series"
}
}
audio: []
date: "2006-01-02"
description: Text about this post
images:
- post-cover.png
series: []
tags: []
title: Post title
videos: []
audio = []
date = '2006-01-02'
description = 'Text about this post'
images = ['post-cover.png']
series = []
tags = []
title = 'Post title'
videos = []
{
"audio": [],
"date": "2006-01-02",
"description": "Text about this post",
"images": [
"post-cover.png"
],
"series": [],
"tags": [],
"title": "Post title",
"videos": []
}
Hugo uses the page title and description for the title and description metadata.
The first 6 URLs from the images
array are used for image metadata.
If page bundles are used and the images
array is empty or undefined, images with file names matching *feature*
or *cover*,*thumbnail*
are used for image metadata.
Various optional metadata can also be set:
- Date, published date, and last modified data are used to set the published time metadata if specified.
audio
andvideos
are URL arrays likeimages
for the audio and video metadata tags, respectively.- The first 6
tags
on the page are used for the tags metadata. - The
series
taxonomy is used to specify related “see also” pages by placing them in the same series.
If using YouTube this will produce a og:video tag like <meta property="og:video" content="url">
. Use the https://youtu.be/<id>
format with YouTube videos (example: https://youtu.be/qtIqKaDlqXo
).
Use the Open Graph template
To add Open Graph metadata, include the following line between the <head>
tags in your templates:
{{ template "_internal/opengraph.html" . }}
Twitter Cards
An internal template for Twitter Cards, metadata used to attach rich media to Tweets linking to your site.
Configure Twitter Cards
Hugo’s Twitter Card template is configured using a mix of configuration variables and front-matter on individual pages.
params:
description: Text about my cool site
images:
- site-feature-image.jpg
[params]
description = 'Text about my cool site'
images = ['site-feature-image.jpg']
{
"params": {
"description": "Text about my cool site",
"images": [
"site-feature-image.jpg"
]
}
}
description: Text about this post
images:
- post-cover.png
title: Post title
description = 'Text about this post'
images = ['post-cover.png']
title = 'Post title'
{
"description": "Text about this post",
"images": [
"post-cover.png"
],
"title": "Post title"
}
If images
aren’t specified in the page front-matter, then hugo searches for image page resources with feature
, cover
, or thumbnail
in their name.
If no image resources with those names are found, the images defined in the site config are used instead.
If no images are found at all, then an image-less Twitter summary
card is used instead of summary_large_image
.
Hugo uses the page title and description for the card’s title and description fields. The page summary is used if no description is given.
Set the value of twitter:site
in your site configuration:
params:
social:
twitter: GoHugoIO
[params]
[params.social]
twitter = 'GoHugoIO'
{
"params": {
"social": {
"twitter": "GoHugoIO"
}
}
}
NOTE: The @
will be added for you
<meta name="twitter:site" content="@GoHugoIO"/>
Use the Twitter Cards template
To add Twitter card metadata, include the following line immediately after the <head>
element in your templates:
{{ template "_internal/twitter_cards.html" . }}
The internal templates
The code for these templates is located here.
_internal/disqus.html
_internal/google_analytics.html
_internal/opengraph.html
_internal/pagination.html
_internal/schema.html
_internal/twitter_cards.html