jekyll-webmention_io 2.0.2 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4382f474833e2206b0e3d6016a0308b9aafc71f
-  data.tar.gz: b8e5d8b894e2fd35b57d82005583c7b7fca9dc17
+  metadata.gz: 78b32f9c7aed21bc49a703a1fa010f53bef88e9b
+  data.tar.gz: 2b4587543f067474e883aa755d795e8ff3e25386
 SHA512:
-  metadata.gz: d9ee082689c82401ccb06acba124e6729e1e7da07ba8820f897c3792b2fcad38948cb544b586d9a4391404d7a62ed26fa4d04c8e6b6e27a415001601c3a5fdc6
-  data.tar.gz: 21d9be47dab80508be40b69792af0996261b62b1621a1f277cd28f2181cafb338830b45e01eeedbe9c9068d10ab7e588dedc54578a642ba0b01c379878e0fa76
+  metadata.gz: c3aa1b06bf34a4b9beb98b8e06b15a852c99a10320f1955b7269cd5db8e7a2a0886f6378e5c83ec4bf4d595cd14537bc2abea5da99c4defd8ffd6f9455e4add7
+  data.tar.gz: 9941ed468a34f98862698f7ccdb7d5a1a8371025387c56242086cea3b661241551ce67f8755d6f10766fe1eff9c4a5062c67380074718a3042a3115e75a1b307

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Aaron Gustafson
+
+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/README.md

@@ -0,0 +1,109 @@
+# Liquid Webmention Tag for Jekyll and Octopress
+
+This plugin makes it possible to load [webmentions](http://indiewebcamp.com/webmention) from [Webmention.io](http://webmention.io) into your Jekyll and Octopress projects. It currently supports the following:
+
+## Webmention Count
+
+Get a count of webmentions for a page or post using the following liquid tag:
+
+	{% webmention_count YOUR_URL %}
+	
+The output will simply be a number.
+
+## Webmention List
+
+You can get a complete list of webmentions for a page or post using the following liquid tag:
+
+	{% webmentions YOUR_URL %}
+
+If webmentions are found, this is the format they will come out in:
+
+	<div class="webmentions">
+		<ol class="webmentions__list">
+			<!-- if it has a Name/Title, this is the generated code -->
+			<li class="webmentions__item">
+				<article class="webmention webmention--title-only">
+					<!-- if Author this block appears -->
+					<div class="webmention__author vcard">
+						<!-- if Author Link the name is wrapped in a link -->
+						<a class="fn url" href="https://kylewm.com">
+							<!-- if Author Photo -->
+							<img class="webmention__author__photo photo" src="/static/img/users/kyle.jpg" alt="">
+							Kyle Mahan
+						</a>
+					</div>
+					<div class="webmention__title">
+						<a href="https://kylewm.com/2014/03/renaming-my-blog-engine-groomsman-to-red-wind">renaming my blog engine Groomsman to Red Wind</a>
+					</div>
+					<div class="webmention__meta">
+						<time class="webmention__pubdate" datetime="2014-03-13T20:33:42+00:00">13 March 2014</time>
+					</div>
+				</article>
+			</li>
+			<!-- if it has Content, but no Name, this is the generated code -->
+			<li class="webmentions__item">
+				<article class="webmention webmention--content-only">
+					<div class="webmention__meta">
+						<time class="webmention__pubdate" datetime="2014-11-11T15:30:18+00:00">11 November 2014</time>
+						|
+						<a class="webmention__source" href="http://aaronparecki.com/replies/2014/11/11/4/drupal">Permalink</a>
+					</div>
+					<div class="webmention__content">
+						<!-- This is run through Markdown -->
+						<p>@noneck @indiewebcamp Well the good news is there&rsquo;s lots of PHP libraries which should be easy to use in #drupal! <a href="http://indiewebcamp.com/PHP#Libraries">http://indiewebcamp.com/PHP#Libraries</a></p>
+					</div>
+				</article>
+			</li>
+		</ol>
+	</div>
+
+If no webmentions are found, the plugin spits out this:
+
+	<div class="webmentions">
+		<p class="webmentions__not-found">No webmentions were found</p>
+	</div>
+	
+To summarize the classes, here’s what you have to work with:
+
+* `webmentions` - overall container (`div`)
+* `webmentions__list` - the list of webmentions (`ol`)
+* `webmentions__item` - the webmention container (`li`)
+* `webmention` - the webmention itself (`article`)
+	* `webmention--title-only` - title-only variant
+	* `webmention--content-only` - content-only variant
+	* `webmention--author-starts` - variant for when the author’s name starts the title or content
+* `webmention__author` - Author of the webmention (`div`)
+* `webmention__author__photo` - Author’s photo (`img`)
+* `webmention__title` - The webmention’s title (`div`)
+* `webmention__content` - The webmention’s content (`div`)
+* `webmention__meta` - The webmention’s meta information container (`div`)
+* `webmention__pubdate` - The publication date (`time`)
+* `webmention__source` - The webmention permalink (`a`)
+* `webmentions__not-found` - The "no results" message (`p`)
+
+Note: Webmentions are cached to the `.cache` directory in a file named `webmentions_received.yml`. If you are unhappy with how a webmention is displayed, you can alter the HTML in this file, but be careful, the file must remain valid YAML. But if you botch things, you can always delete the file and the webmentions will be re-cached.
+
+## JavaScript (optional)
+
+I have also included a JavaScript file that will keep your webmentions up to date even when you don’t publish frequently. It will also update your page’s webmentions in realtime.
+
+To inform the JavaScript of additional URLs to check (e.g. when the current page receives redirects from old URLs), use the following `meta` element:
+
+	<meta property="webmention:redirected_from" content="URL_1,URL_2">
+
+The `content` attribute should contain a single URL or multiple URLs separated by commas.
+
+## Publishing Webmentions
+
+Included in this repo is a [Rake](https://github.com/ruby/rake) task for publishing webmentions (webmention.Rakefile). You can add this task to your global Rakefile or reference it. Just be sure to update the path for your `.cache` folder
+
+The workflow is as follows:
+
+1. `rake generate` to generate your site and collect a list of mentioned URLs in your posts
+2. `rake webmention` to cycle through those URLs and post to any that offer webmention endpoints.
+
+Notes:
+
+ * If an endpoint is not offered, the URL will be skipped and can be processed later.
+ * In order to streamline the process, a webmention connection will only be processed once (and cached so it can be skipped).
+ * You may want to add `.cache` to your `.gitignore` file.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+#require 'rspec/core/rake_task'
+
+#RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/jekyll/generators/gather_webmentions.rb

@@ -212,7 +212,7 @@ module Jekyll
 							# cleanup
               title = title.gsub(%r{</?[^>]+?>}, '')
 						end # if no title
-						webmention['title'] = markdownify( title )
+						webmention['title'] = markdownify( title ) if title
 
 						# Everything else
 						content = link['data']['content']

data/lib/jekyll/webmention_io/version.rb

@@ -1,3 +1,3 @@
 module WebmentionIO
-  VERSION = "2.0.2"
+  VERSION = "2.0.5"
 end

data/templates/likes.html

@@ -2,7 +2,7 @@
 	{% if webmentions.size > 0 %}
 		<ol class="webmentions__list">
 			{% for webmention in webmentions %}
-				<li id="webmention-{{ webmention.id }}" class="webmentions__item webmentions__item--{{ webmention.type }}">
+				<li id="webmention-{{ webmention.id }}" class="webmentions__item webmention webmention--{{ webmention.type }}">
 					<div class="webmention__author p-author h-card">
 						<a class="u-url" href="{{ webmention.author.url }}">
 							<img class="webmention__author__photo u-photo" src="{{ webmention.author.photo }}" alt="" title="{{ webmention.author.name }}">

data/templates/links.html

@@ -2,7 +2,7 @@
 	{% if webmentions.size > 0 %}
 		<ol class="webmentions__list">
 			{% for webmention in webmentions %}
-				<li id="webmention-{{ webmention.id }}" class="webmentions__item webmentions__item--{{ webmention.type }}">
+				<li id="webmention-{{ webmention.id }}" class="webmentions__item webmention webmention--{{ webmention.type }}">
 					{{ webmention.content }}
           <div class="webmention__meta">
 						{% if webmention.author %}

data/templates/posts.html

@@ -2,7 +2,7 @@
 	{% if webmentions.size > 0 %}
 		<ol class="webmentions__list">
 			{% for webmention in webmentions %}
-				<li id="webmention-{{ webmention.id }}" class="webmentions__item webmentions__item--{{ webmention.type }}">
+				<li id="webmention-{{ webmention.id }}" class="webmentions__item webmention webmention--{{ webmention.type }}">
 					<a class="webmention__title webmention__source u-url" href="{{ webmention.url }}">{{ webmention.title }}</a>
           <div class="webmention__meta">
             {% if webmention.pubdate %}

data/templates/replies.html

@@ -1,8 +1,8 @@
-<div class="webmentions">
+<div class="webmentions webmentions--replies">
 	{% if webmentions.size > 0 %}
 		<ol class="webmentions__list">
 			{% for webmention in webmentions %}
-				<li id="webmention-{{ webmention.id }}" class="webmentions__item webmentions__item--{{ webmention.type }}">
+				<li id="webmention-{{ webmention.id }}" class="webmentions__item webmention webmention--{{ webmention.type }}">
 					{{ webmention.content }}
 					<div class="webmention__meta">
 						{% if webmention.author %}

data/templates/reposts.html

@@ -2,7 +2,7 @@
 	{% if webmentions.size > 0 %}
 		<ol class="webmentions__list">
 			{% for webmention in webmentions %}
-				<li id="webmention-{{ webmention.id }}" class="webmentions__item webmentions__item--{{ webmention.type }}">
+				<li id="webmention-{{ webmention.id }}" class="webmentions__item webmention webmention--{{ webmention.type }}">
 					<div class="webmention__author p-author h-card">
 						<a class="u-url" href="{{ webmention.author.url }}">
 							<img class="webmention__author__photo u-photo" src="{{ webmention.author.photo }}" alt="" title="{{ webmention.author.name }}">

data/templates/webmentions.html

@@ -2,9 +2,8 @@
 	{% if webmentions.size > 0 %}
 		<ol class="webmentions__list">
 			{% for webmention in webmentions %}
-				<li id="webmention-{{ webmention.id }}" class="webmentions__item webmentions__item--{{ webmention.type }}">
-					<article class="h-cite
-						{{ webmention.classes }}
+				<li id="webmention-{{ webmention.id }}" class="webmentions__item">
+					<article class="h-cite webmention webmention--{{ webmention.type }}
 						{% unless webmention.author %}webmention--no-author{% endunless %}
 						{% unless webmention.author.photo %}webmention--no-photo{% endunless %}
 						{% if webmention.is_tweet == true %}webmention--author-starts{% endif %}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-webmention_io
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.5
 platform: ruby
 authors:
 - Aaron Gustafson
@@ -145,6 +145,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
 - assets/webmention_io.js
 - lib/jekyll-webmention_io.rb
 - lib/jekyll/commands/webmention.rb