eleventy-plugin-seo-tag

    0.5.3 • Public • Published

    About Eleventy Plugin SEO

    An Eleventy plugin to generate meta tags for improved SEO using the Liquid or Nujucks templating engines.

    GitHub Actions GitHub Actions code style: prettier Test Coverage Maintainability

    I wrote this plugin when moving from Jekyll to Eleventy to get the functionality I previously had with Jekyll SEO Tag.

    Features

    • Page title with styling options and pagination.
    • Page description.
    • Canonical URL.
    • Robots meta directive for pagination.
    • Author meta directive.
    • Open Graph markup.
    • Twitter Card markup.
    • Supports Liquid and Nunjucks.

    Installation

    Available on npm:

    npm install eleventy-plugin-seo --save

    Add the plugin to .eleventy.js:

    const pluginSEO = require("eleventy-plugin-seo");
     
    module.exports =  function(eleventyConfig) {
      eleventyConfig.addPlugin(pluginSEO, require("./src/_data/seo.json"));
    };

    Usage

    Add the following right before </head> in your site's template(s):

    Liquid:

    {% seo %}
    

    Nunjucks:

    {% seo "" %}
    

    Done!

    Front Matter

    The plugin uses these front matters when available:

    ---
    title:   Some page title
    excerpt: Some page excerpt
    author:  Jane Doe
    image:   foo.jpg
    ogtype:  website
    ---

    ogtype defaults to article, set it to website or something more appropriate via front matter where required.

    Config

    Pass in an object with config options to the plugin:

    eleventyConfig.addPlugin(pluginSEO, {
      title: "Foobar Site",
      description: "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
      url: "https://foo.com",
      author: "Jane Doe",
      twitter: "username",
      image: "foo.jpg"
    });

    Alternatively keep the options in an external file and require it:

    eleventyConfig.addPlugin(pluginSEO, require("./src/_data/seo.json"));

    title

    Uses the title in front matter and by default the site title gets appended to the page title, page title - site title. Page with page number gets appended to the page title when paginated.

    See options for customization.

    description

    Uses front matter excerpt to generate the description. If no excerpt is set for a page it falls back on using the site description in the config.

    url

    Full URL to the site without trailing slash, https://foo.com.

    author

    Full name of the site author, Jane Doe. Can be overridden on a per page basis using author in front matter.

    twitter

    Twitter username for the author of the site. Used when generating the markup for Twitter cards.

    image

    URL to default image to use if none is set in front matter when creating markup blocks for open graph and Twitter cards.

    Options

    The behavior of the output can be controlled via an options object that can be passed in with the config.

    eleventyConfig.addPlugin(pluginSEO, {
      title: "Foobar Site",
      ...
      options: {
        titleStyle: "minimalistic",
        titleDivider: "|",
        imageWithBaseUrl: true
      }
    });

    titleStyle

    Setting the style to minimalistic removes the appending of the site title to all title strings.

    titleDivider

    Changes the divider between elements in the title output from - to any custom character or string.

    imageWithBaseUrl

    Prepends the config url to the image option.

    Additional Tags

    While adding the seo tag is all that is needed, the plugin defines more tags that it uses internally that can be convenient to use in other places.

    Install

    npm i eleventy-plugin-seo-tag

    DownloadsWeekly Downloads

    1

    Version

    0.5.3

    License

    MIT

    Unpacked Size

    26.2 kB

    Total Files

    23

    Last publish

    Collaborators

    • huahaiy