jekyll-seo-tag 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f841664e9807e1d76d4ce51846a5f3b7d3239457
-  data.tar.gz: 53aa91acd74b1e52119a51d484ced2c99da32587
+  metadata.gz: 24b1466116c0edcefb7df6ea675eca5d08735626
+  data.tar.gz: 3effdcadd767625bd1418d1f3c0d36a3b50c7a13
 SHA512:
-  metadata.gz: 108c1ea4cdf5286e00d7727c0dcfd207021959f457117de75a33c012905f5cd3413ff87708fb6297a9171730f0c9592c6a52904bad8ff991da63aae5bb27a894
-  data.tar.gz: d4a22ada3a1311d1a8b1149dff77a2a0435d97a8db78431fc33a42819f777d763f5f7daddb70bc151a802aa16c35ed4f6a2a5a59eede963808f7d87f55bbfecf
+  metadata.gz: f39e1738e4cdaab1fe7aa0fe139f6fba9fa2479dcb0a0d5167d5132f444e3eae04d0afff321cb58c1f93b5bf666cd9d94c250c73b7779ca7d3f68021882b4007
+  data.tar.gz: a3888cf97e85b7a66461a225d68e54048a95caeaa039dbb9f3c9e74a18113f5fa46210650f5f251414c7f5a0e6a985d429ef2621f8e671b7b9b50ffcb808fd5f

data/README.md

@@ -52,17 +52,22 @@ The SEO tag will respect any of the following if included in your site's `_confi
 * `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.
+* `author` - global author information (see below)
 * `twitter:username` - The site's Twitter handle. You'll want to describe it like so:
+
   ```yml
   twitter:
     username: benbalter
   ```
+
 * `facebook:app_id` (A Facebook app ID for Facebook insights), and/or `facebook:publisher` (A Facebook page URL or ID of the publishing entity). You'll want to describe one or both like so:
+
    ```yml
    facebook:
      app_id: 1234
      publisher: 1234
    ```
+
 * `logo` - Relative URL to a site-wide logo (e.g., `assets/your-company-logo.png`)
 * `social` - For [specifying social profiles](https://developers.google.com/structured-data/customize/social-profiles). The following properties are available:
   * `type` - Either `person` or `organization` (defaults to `person`)
@@ -75,4 +80,68 @@ The SEO tag will respect the following YAML front matter if included in a post,
 * `title` - The title of the post, page, or document
 * `description` - A short description of the page's content
 * `image` - Relative URL to an image associated with the post, page, or document (e.g., `assets/page-pic.jpg`)
-* `author` - The username of the post, page, or document author
+* `author` - Page-, post-, or document-specific author information (see below)
+
+### Disabling `<title>` output
+
+Jekyll SEO Tag is designed to implement SEO best practices by default. If for some reason, you don't want the plugin to output `<title>` tags on each page, simply invoke the plugin within your template like so:
+
+```
+{% seo title=false %}
+```
+
+### Author information
+
+Author information is used to propagate the `creator` field of Twitter summary cards. This is should be an author-specific, not site-wide Twitter handle (the site-wide username be stored as `site.twitter.username`).
+
+*TL;DR: In most cases, put `author: [your Twitter handle]` in the document's front matter, for sites with multiple authors. If you need something more complicated, read on.*
+
+There are several ways to convey this author-specific information. Author information is found in the following order of priority:
+
+1. An `author` object, in the documents's front matter, e.g.:
+
+  ```yml
+  author:
+    twitter: benbalter
+  ```
+
+2. An `author` object, in the site's `_config.yml`, e.g.:
+
+  ```yml
+  author:
+    twitter: benbalter
+  ```
+
+3. `site.data.authors[author]`, if an author is specified in the document's front matter, and a corresponding key exists in `site.data.authors`. E.g., you have the following in the document's front matter:
+
+  ```yml
+  author: benbalter
+  ```
+
+  And you have the following in `_data/authors.yml`:
+
+  ```yml
+  benbalter:
+    picture: /img/benbalter.png
+    twitter: jekyllrb
+
+  potus:
+    picture: /img/potus.png
+    twitter: whitehouse
+  ```
+
+  In the above example, the author `benbalter`'s Twitter handle will be resolved to `@jekyllrb`. This allows you to centralize author information in a single `_data/authors` file for site with many authors that require more than just the author's username.
+
+  *Pro-tip: If `authors` is present in the document's front matter as an array (and `author` is not), the plugin will use the first author listed, as Twitter supports only one author.*
+
+4. An author in the document's front matter (the simplest way), e.g.:
+
+  ```yml
+  author: benbalter
+  ```
+
+5. An author in the site's `_config.yml`, e.g.:
+
+  ```yml
+  author: benbalter
+  ```

data/lib/jekyll-seo-tag.rb

@@ -6,22 +6,37 @@ module Jekyll
 
     MINIFY_REGEX = /(>\n|[%}]})\s+(<|{[{%])/
 
+    def initialize(_tag_name, text, _tokens)
+      super
+      @text = text
+    end
+
     def render(context)
       @context = context
-      output = template.render!(payload, info)
-
-      output
+      template.render!(payload, info)
     end
 
     private
 
+    def options
+      {
+        'version' => VERSION,
+        'title'   => title?
+      }
+    end
+
     def payload
       {
-        'page' => context.registers[:page],
-        'site' => context.registers[:site].site_payload['site']
+        'page'    => context.registers[:page],
+        'site'    => context.registers[:site].site_payload['site'],
+        'seo_tag' => options
       }
     end
 
+    def title?
+      !(@text =~ /title=false/i)
+    end
+
     def info
       {
         registers: context.registers,

data/lib/jekyll-seo-tag/version.rb

@@ -3,6 +3,6 @@ module Liquid; class Tag; end; end
 
 module Jekyll
   class SeoTag < Liquid::Tag
-    VERSION = '1.1.0'.freeze
+    VERSION = '1.2.0'.freeze
   end
 end

data/lib/template.html

@@ -1,4 +1,4 @@
-<!-- Begin Jekyll SEO tag -->
+<!-- Begin Jekyll SEO tag v{{ seo_tag.version }} -->
 
 {% if site.url %}
   {% assign seo_url = site.url | append: site.baseurl %}
@@ -39,16 +39,21 @@
   {% assign seo_description = seo_description | markdownify | strip_html | strip_newlines | escape_once %}
 {% endif %}
 
-{% if page.author %}
-  {% assign seo_author_name = page.author.name | default: page.author %}
-  {% assign seo_author_twitter = page.author.twitter | default: page.author %}
-{% endif %}
-
-{% if seo_author_twitter %}
-  {% assign seo_author_twitter = seo_author_twitter | replace:"@","" | prepend:"@" %}
+{% assign seo_author = page.author | default: page.authors[0] | default: site.author %}
+{% if seo_author %}
+  {% if seo_author.twitter %}
+    {% assign seo_author_twitter = seo_author.twitter %}
+  {% else %}
+    {% if site.data.authors and site.data.authors[seo_author] %}
+      {% assign seo_author_twitter = site.data.authors[seo_author].twitter  %}
+    {% else %}
+      {% assign seo_author_twitter = seo_author  %}
+    {% endif %}
+  {% endif %}
+  {% assign seo_author_twitter = seo_author_twitter | replace:"@","" %}
 {% endif %}
 
-{% if seo_title %}
+{% if seo_tag.title and seo_title %}
   <title>{{ seo_title }}</title>
 {% endif %}
 
@@ -117,7 +122,7 @@
   {% endif %}
 
   {% if seo_author_twitter %}
-    <meta name="twitter:creator" content="{{ seo_author_twitter }}" />
+    <meta name="twitter:creator" content="@{{ seo_author_twitter }}" />
   {% endif %}
 {% endif %}
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-seo-tag
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-20 00:00:00.000000000 Z
+date: 2016-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll