eleventy-plugin-metagen
Advanced tools
Readme
An Eleventy shortcode that generates document metadata containing: Open Graph, Twitter card, generic meta tags and a canonical link.
In your Eleventy project, install the plugin from npm:
npm install eleventy-plugin-metagen
Then add it to your Eleventy Config file:
const metagen = require('eleventy-plugin-metagen');
module.exports = (eleventyConfig) => {
eleventyConfig.addPlugin(metagen);
};
The plugin turns 11ty shortcodes like this:
{% metagen
title="Eleventy Plugin Add Meta Tags",
desc="An eleventy shortcode for generating meta tags.",
url="https://tannerdolby.com",
img="https://tannerdolby.com/images/arch-spiral-large.jpg",
img_alt="Archimedean Spiral",
twitter_card_type="summary_large_image",
twitter_handle="tannerdolby",
name="Tanner Dolby"
%}
into <meta> tags and other document metadata like this:
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width initial-scale=1">
<title>Eleventy Plugin Add Meta Tags</title>
<meta name="author" content="Tanner Dolby">
<meta name="description" content="An eleventy shortcode for generating meta tags.">
<meta property="og:title" content="Eleventy Plugin Add Meta Tags">
<meta property="og:type" content="website">
<meta property="og:description" content="An eleventy shortcode for generating meta tags.">
<meta property="og:url" content="https://tannerdolby.com">
<meta property="og:image" content="https://tannerdolby.com/images/arch-spiral-large.jpg">
<meta property="og:image:alt" content="Archimedean Spiral">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@tannerdolby">
<meta name="twitter:title" content="Eleventy Plugin Add Meta Tags">
<meta name="twitter:description" content="An eleventy shortcode for generating meta tags.">
<meta name="twitter:image" content="https://tannerdolby.com/images/arch-spiral-large.jpg">
<meta name="twitter:image:alt" content="Archimedean Spiral">
<link rel="canonical" href="https://tannerdolby.com">
Providing all eight comma separated arguments to metagen is recommended. You might only need a few <meta> tags instead of the whole set, simply provide the arguments you need and the ones not included won't generate <meta> tags.
Besides the default generated <meta> tags, only the arguments you provide data for will be generated as <meta> tags. This allows you to include some of your own tags alongside metagen if you need. Template variables can be used in the Nunjucks and Liquid shortcode parameters without the curly braces or quotes like title=page.url (Nunjucks) or title (Liquid). More on template variable usage below.
If atleast one parameter is provided to metagen, the default tags aside from the main Open Graph and Twitter card data are:
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width initial-scale=1">
<title></title>
<meta name="author" content="">
<meta name="description" content="">
<meta property="og:type" content="website">
<meta name="twitter:card" content="summary">
The title parameter provides data for <title>. If title is not defined within metagen, the <title> element will not be generated with the above default tags. The same rules apply for name and desc. All other parameters if omitted, will not have meta tags generated.
Using {% metagen %} without any arguments will throw Error: No data was added into the meta generator and return an empty string.
To turn the shortcode into a one-liner, you can define an object in front matter, global data or another data source with the required key/value pairs and supply the shortcode with a single parameter.
---
data:
title: Eleventy Plugin Add Meta Tags
desc: An eleventy shortcode for generating meta tags.
url: https://tannerdolby.com
img: https://tannerdolby.com/images/arch-spiral-large.jpg
img_alt: Archimedean Spiral
twitter_card_type: summary_large_image
twitter_handle: tannerdolby
name: Tanner Dolby
---
<head>
{% metagen data %}
</head>
To make your metadata dynamic, you can use template data as arguments to the shortcode, without quotes or braces:
---
title: Some title
desc: Some description
metadata:
title: Some other title
desc: Some other description
url: https://tannerdolby.com
image: https://tannerdolby.com/images/arch-spiral-large.jpg
alt: Archimedean spiral
twitter: "@tannerdolby"
name: Tanner Dolby
---
{% metagen
title=title or metadata.title,
desc=desc or metadata.desc,
url=url + page.url,
img=image,
img_alt=alt,
twitterHandle=twitter,
name=name
%}
As a general rule, don't forget your in a templating engine context. Use your variables in the shortcode as you would inside {% var %} tags or {{ var }}.
If you would like to use Liquid (which is the default templating engine in Eleventy). Then utilize the following syntax, to turn shortcodes like this:
---
data:
title: Eleventy Plugin Add Meta Tags
desc: An eleventy shortcode for generating meta tags.
url: https://tannerdolby.com
img: https://tannerdolby.com/images/arch-spiral-large.jpg
img_alt: Archimedean Spiral
twitter_card_type: summary_large_image
twitter_handle: 'tannerdolby'
name: Tanner Dolby
---
<head>
{% metagen data %}
</head>
into <meta> tags and document metadata like this:
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Eleventy Plugin Add Meta Tags</title>
<meta name="author" content="Tanner Dolby">
<meta name="description" content="An eleventy shortcode for generating meta tags.">
<meta property="og:title" content="Eleventy Plugin Add Meta Tags">
<meta property="og:type" content="website">
<meta property="og:description" content="An eleventy shortcode for generating meta tags.">
<meta property="og:url" content="https://tannerdolby.com">
<meta property="og:image" content="https://tannerdolby.com/images/arch-spiral-large.jpg">
<meta property="og:image:alt" content="Archimedean Spiral">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="tannerdolby">
<meta name="twitter:title" content="Eleventy Plugin Add Meta Tags">
<meta name="twitter:description" content="An eleventy shortcode for generating meta tags.">
<meta name="twitter:image" content="https://tannerdolby.com/images/arch-spiral-large.jpg">
<meta name="twitter:image:alt" content="Archimedean Spiral">
<link rel="canonical" href="https://tannerdolby.com">
The Liquid usage is a bit different as the shortcode expects a single parameter representing an object with key/value pairs. You can define the object in front matter like I've shown above, or you could define the metadata object in global data to pull into the template.
FAQs
An Eleventy shortcode that generates document metadata containing: Open Graph, Twitter card, generic meta tags and a canonical link.
We found that eleventy-plugin-metagen demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).