Mr. Poole's Jekyll Tools

.___  ___. .______                    _-----_
|   \/   | |   _  \                   | - - |
|  \  /  | |  |_)  |                  |  ω  |
|  |\/|  | |      /                   | ___ |
|  |  |  | |  |\  \     __          __'.___.'__
|__|  |__| | _| `._\   (__)        ´    >-<    `

.______     ______     ______    __       _______
|   _  \   /  __  \   /  __  \  |  |     |   ____|
|  |_)  | |  |  |  | |  |  |  | |  |     |  |__
|   ___/  |  |  |  | |  |  |  | |  |     |   __|
|  |      |  `--'  | |  `--'  | |  `----.|  |____
| _|       \______/   \______/  |_______||_______|

For the Yeoman generator that set's up a Jekyll site for you, check out Mr. Poole, the Jekyll Site Generator.

This set of tools are some extensions to Jekyll to help make your site a little better.

Installation

Add this line to your application's Gemfile:

gem 'jekyll-poole'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-poole

Use

You must first ensure Jekyll is pulling in this extension. Common practices are to copy the following code into _plugins/ext.rb:

require 'jekyll-poole'

Adding in Open Graph tags

The primary use of the Mr. Poole's Jekyll extension is to add in the proper meta tags for Open Graph, and other meta-information. You can add in all tags available by adding the following code within your tag.

{% poole_tags %}

Optionally, you may choose any of the following tags to insert them in one-by-one.

{% poole_tags site_name %}

Adds in the og:site_name tag. This will pull from the tite in _config.yml.

{% poole_tags title %}

Puts in the og:title tag. This will be either the page title, or the site_name if a page title is not present.

{% poole_tags type %}

The og:type tag. This will be 'article' unless a page title is not set, in which it will be 'website'.

{% poole_tags description %}

The og:description tag. This will be pulled from an option "description" from the post's frontmatter. Working on having this pull from the post's excerpt if this does not exist.

{% poole_tags published_time %}

The article:published_time tag, which pulls from page's date. Will be properly formatted in the iso8601 format.

{% poole_tags author %}

The article:author tag, which will pull from the page's 'author' frontmatter if it is set. If not, it will be set to the site's author set in _config.yml.

{% poole_tags url %}
{% poole_tags canonical %}

The url tag will add in the og:url tag, and the canonical will add in the canonical tag. Both will pull from the page's permalink.

{% poole_tags image %}

This will add in a og:image tag. If there is an 'image' setting on the post or page, then it will use that. If not, it will pull from the og_image from the _config.yml. If neither are set, then it will be ignored.

Thanks, Praise, Etc.

Big thanks to @ixti, whose code for jekyll-assets was great inspiration for this extension. Also to @parkr who helped me with the tests, and wrote Jekyll.

License

MIT