jekyll-seo-tag/README.md

Jekyll SEO Tag

A Jekyll plugin to add metadata tags for search engines and social networks to better index and display your site's content.

What it does

Jekyll SEO Tag adds the following meta tags to your site:

• Pages title (with site title appended when available)
• Page description
• Canonical URL
• Next and previous URLs for posts
• JSON-LD Site and post metadata for richer indexing
• Open graph title, description, site title, and URL (for Facebook, LinkedIn, etc.)
• Twitter summary card metadata

What it doesn't do

Jekyll SEO tag is designed to output machine-readable metadata for search engines and social networks to index and display. If you're looking for something to analyze your Jekyll site's structure and content (e.g., more traditional SEO optimization), take a look at The Jekyll SEO Gem.

Installation

1. Add the following to your site's Gemfile:

gem 'jekyll-seo-tag'

2. Add the following to your site's _config.yml:

gems:
  - jekyll-seo-tag

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

  {% seo %}

Usage

The SEO tag will respect any of the following if included in your site's _config.yml (and simply not include them if they're not defined):

• title - Your site's title (e.g., Ben's awesome site, The GitHub Blog, etc.)
• description - A short description (e.g., A blog dedicated to reviewing cat gifs)
• url - The full URL to your site. Note: site.github.url will be used by default.
• twitter:username - The site's Twitter handle. You'll want to describe it like so:

  twitter:
    username: benbalter
  

• logo - Relative URL to a site-wide logo (e.g., assets/your-company-logo.png)
• social - For specifying social profiles. The following properties are available:
  • type - Either person or organization
  • name - If the user or organization name differs from the site's name
  • links - An array of links to social media profiles.

The SEO tag will respect the following YAML front matter if included in a post, page, or document:

• title - The title of the post, page, or document
• description - A short description of the page's content
• image - The absolute URL to an image that should be associated with the post, page, or document
• author - The username of the post, page, or document author