bunto-seo-tag 5.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8573537e849dac3b23e44eff7e2c7b1bd21cd511
-  data.tar.gz: ef1899ae99ef7a2f87d5de35fb69bc3e24fb9e2a
+  metadata.gz: 216785d368b04b4f537ebaac9b0acd30d9558baa
+  data.tar.gz: 1e5632910a531af2629ca9236309e269db65818d
 SHA512:
-  metadata.gz: 9347f818a5f4298d30fc1dc52c0ce21343ed5c82d5ecba8da67cb1852f27b0564552251ce2dee64263bd26c02de912ad876c7c38cad42986654bf458f1825772
-  data.tar.gz: 790af8f3dd227159720e03a3dee4bbacc2176ca1892d09f20a13d7b0b6f8f8afdb3e14f96784557995b19e42a2c973be934a489668072f4a1b22466cd738dd7e
+  metadata.gz: ff65e4c12a0d592d3d3f1a0d46aa666ab9abea21f4b4fd74bda4f7fdca854f4b83ddcb895b89c2ef0f7c66fd0b40d5430f10b051ab10e950b3e828c275233684
+  data.tar.gz: aee2b56e22f328eb7d25be10ce68247f79aae2ad73d1b29521469df8ef45126cbe51b29ff06023b32277064f2e1d6b0ebeac3526caf0d887887729f2dede2e27

data/.gitignore

@@ -1,10 +1,12 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/bin/
+*.gem
+_site

data/.rspec

@@ -1,2 +1,2 @@
---format documentation
---color
+--color
+--require spec_helper

data/.rubocop.yml

@@ -1,10 +1,25 @@
-Metrics/LineLength:
-  Exclude:
-    - spec/**/*
-    - bunto-seo-tag.gemspec
-
-Style/Documentation:
-  Enabled: false
-
-Style/FileName:
-  Enabled: false
+inherit_gem:
+  bunto: .rubocop.yml
+
+Metrics/LineLength:
+  Exclude:
+    - spec/**/*
+    - bunto-seo-tag.gemspec
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Style/Documentation:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/IndentHeredoc:
+  Exclude:
+    - spec/**/*
+
+AllCops:
+  Exclude:
+    - vendor/**/*

data/.travis.yml

@@ -1,12 +1,12 @@
-# Travis CI
-rvm:
-  - 2.2.3
-langauage: ruby
-before_script:
-  - chmod a+x script/bootstrap
-  - chmod a+x script/cibuild
-  - chmod a+x script/release
-  - gem install bundler
-script: script/cibuild
-sudo: false
-cache: bundler
+rvm:
+  - 2.2.3
+before_install:
+  - gem install bundler
+  - chmod a+x script/bootstrap
+  - chmod a+x script/cibuild
+  - chmod a+x script/release
+  - chmod a+x script/site
+language: ruby
+script: script/cibuild
+sudo: false
+cache: bundler

data/Gemfile

@@ -1,16 +1,7 @@
-source 'https://rubygems.org'
-require 'json'
-require 'open-uri'
-
-gemspec
-
-group :development, :test do
-  versions = JSON.parse(open('https://pages.github.com/versions.json').read)
-  versions.delete('ruby')
-  versions.delete('bunto-seo-tag')
-  versions.delete('github-pages')
-
-  versions.each do |dep, version|
-    gem dep, version
-  end
-end
+source "https://rubygems.org"
+require "json"
+require "open-uri"
+
+gemspec
+
+gem "github-pages", :group => :bunto_plugins

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2016-present Ben Balter
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2015-present Ben Balter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/bunto-seo-tag.gemspec

@@ -1,34 +1,34 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'bunto-seo-tag/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'bunto-seo-tag'
-  spec.version       = Bunto::SeoTag::VERSION
-  spec.authors       = ['Ben Balter', 'Suriyaa Kudo']
-  spec.email         = ['ben.balter@github.com', 'SuriyaaKudoIsc@users.noreply.github.com']
-  spec.summary       = "A Bunto plugin to add metadata tags for search engines and social networks to better index and display your site's content."
-  spec.homepage      = 'https://github.com/bunto/bunto-seo-tag'
-  spec.license       = 'MIT'
-
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
-  end
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'bunto'
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.3'
-  spec.add_development_dependency 'html-proofer', '~> 2.5'
-  spec.add_development_dependency 'rubocop', '~> 0.37'
-end
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bunto-seo-tag/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bunto-seo-tag"
+  spec.version       = Bunto::SeoTag::VERSION
+  spec.authors       = ["Ben Balter", "Suriyaa Kudo"]
+  spec.email         = ["ben.balter@github.com", "github@suriyaa.tk"]
+  spec.summary       = "A Bunto plugin to add metadata tags for search engines and social networks to better index and display your site's content."
+  spec.homepage      = "https://github.com/bunto/bunto-seo-tag"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|spec|features)/!) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r!^exe/!) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bunto", "~> 3.4"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "html-proofer", "~> 3.6"
+  spec.add_development_dependency "rubocop", "~> 0.48"
+end

data/docs/README.md

@@ -0,0 +1,33 @@
+## About Bunto SEO Tag
+
+A Bunto plugin to add metadata tags for search engines and social networks to better index and display your site's content.
+
+[![Gem Version](https://badge.fury.io/rb/bunto-seo-tag.svg)](https://badge.fury.io/rb/bunto-seo-tag) [![Build Status](https://travis-ci.org/bunto/bunto-seo-tag.svg)](https://travis-ci.org/bunto/bunto-seo-tag)
+
+## What it does
+
+Bunto SEO Tag adds the following meta tags to your site:
+
+* Page title, with site title or description appended
+* Page description
+* Canonical URL
+* Next and previous URLs on paginated pages
+* [JSON-LD Site and post metadata](https://developers.google.com/structured-data/) for richer indexing
+* [Open Graph](http://ogp.me/) title, description, site title, and URL (for Facebook, LinkedIn, etc.)
+* [Twitter Summary Card](https://dev.twitter.com/cards/overview) metadata
+
+While you could theoretically add the necessary metadata tags yourself, Bunto SEO Tag provides a battle-tested template of crowdsourced best-practices.
+
+## What it doesn't do
+
+Bunto 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 Bunto site's structure and content (e.g., more traditional SEO optimization), take a look at [The Bunto SEO Gem](https://github.com/pmarsceill/bunto-seo-gem).
+
+Bunto SEO tag isn't designed to accommodate every possible use case. It should work for most site out of the box and without a laundry list of configuration options that serve only to confuse most users.
+
+## Documentation
+
+For more information, see:
+
+* [Installation](installation.md)
+* [Usage](usage.md)
+* [Advanced usage](advanced-usage.md)

data/docs/_config.yml

@@ -0,0 +1,10 @@
+title: Bunto SEO Tag
+description: A Bunto plugin to add metadata tags for search engines and social networks to better index and display your site's content.
+
+permalink: pretty
+
+gems:
+  - bunto-seo-tag
+  - bunto-sitemap
+
+theme: bunto-theme-primer

data/docs/_layouts/default.html

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}" rel="stylesheet">
+    {% seo %}
+  </head>
+  <body>
+    <div class="container markdown-body">
+      <h1>{{ site.title }}</h1>
+      
+      {{ content }}
+    </div>
+    <script src="{{ "assets/javascript/anchor-js/anchor.min.js" | relative_url }}"></script>
+    <script>anchors.add();</script>
+  </body>
+</html>

data/docs/advanced-usage.md

@@ -0,0 +1,138 @@
+## Advanced usage
+
+Bunto SEO Tag is designed to implement SEO best practices by default and to be the right fit for most sites right out of the box. If for some reason, you need more control over the output, read on:
+
+### Disabling `<title>` output
+
+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 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: buntowaf
+
+  potus:
+    picture: /img/potus.png
+    twitter: whitehouse
+  ```
+
+  In the above example, the author `benbalter`'s Twitter handle will be resolved to `@buntowaf`. 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
+  ```
+
+### Customizing JSON-LD output
+
+The following options can be set for any particular page. While the default options are meant to serve most users in the most common circumstances, there may be situations where more precise control is necessary.
+
+* `seo`
+  * `name` - If the name of the thing that the page represents is different from the page title. (i.e.: "Frank's Café" vs "Welcome to Frank's Café")
+  * `type` - The type of things that the page represents. This must be a [Schema.org type](http://schema.org/docs/schemas.html), and will probably usually be something like [`BlogPosting`](http://schema.org/BlogPosting), [`NewsArticle`](http://schema.org/NewsArticle), [`Person`](http://schema.org/Person), [`Organization`](http://schema.org/Organization), etc.
+  * `links` - An array of other URLs that represent the same thing that this page represents. For instance, Jane's bio page might include links to Jane's GitHub and Twitter profiles.
+
+### Customizing image output
+
+For most users, setting `image: [path-to-image]` on a per-page basis should be enough. If you need more control over how images are represented, the `image` property can also be an object, with the following options:
+
+* `path` - The relative path to the image. Same as `image: [path-to-image]`
+* `height` - The height of the Open Graph (`og:image`) image
+* `width` - The width of the Open Graph (`og:image`) image
+
+You can use any of the above, optional properties, like so:
+
+```yml
+image:
+  path: /img/twitter.png
+  height: 100
+  width: 100
+```
+
+### Setting a default image
+
+You can define a default image using [Front Matter default](https://buntowaf.tk/docs/configuration/#front-matter-defaults), to provide a default Twitter Card or OGP image to all of your posts and pages.
+
+Here is a very basic example, that you are encouraged to adapt to your needs:
+
+```yml
+defaults:
+  - scope:
+      path: ""
+    values:
+      image: /assets/images/default-card.png
+```
+
+### SmartyPants Titles
+
+Titles will be processed using [Bunto's `smartify` filter](https://buntowaf.tk/docs/templates/). This will use SmartyPants to translate plain ASCII punctuation into "smart" typographic punctuation. This will not render or strip any Markdown you may be using in a page title.
+
+### Setting customized Canonical URL
+
+You can set custom Canonical URL for a page by specifying canonical_url option in page front-matter.
+E.g., you have the following in the page's front matter:
+```yml
+layout: post
+title: Title of Your Post
+canonical_url: 'https://github.com/bunto/bunto-seo-tag/'
+```
+
+Which will generate canonical_url with specified link in canonical_url.
+```html
+<link rel="canonical" href="https://github.com/bunto/bunto-seo-tag/" />
+```
+
+If no canonical_url option was specified, then uses page url for generating canonical_url.
+E.g., you have not specified canonical_url in front-matter:
+```yml
+layout: post
+title: Title of Your Post
+```
+
+Which will generate following canonical_url:
+```html
+<link rel="canonical" href="http://yoursite.com/title-of-your-post" />
+```

data/docs/installation.md

@@ -0,0 +1,20 @@
+# Installing Bunto SEO Tag
+
+1. Add the following to your site's `Gemfile`:
+
+  ```ruby
+  gem 'bunto-seo-tag'
+  ```
+
+2. Add the following to your site's `_config.yml`:
+
+  ```yml
+  gems:
+    - bunto-seo-tag
+  ```
+
+3. Add the following right before `</head>` in your site's template(s):
+
+  ```liquid
+  {% seo %}
+  ```