jekyll-auto-image 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18c13b5cac681464310ff3fbb71d4b75fb7a98e8
-  data.tar.gz: 9e07cff0479b14b9f746730b28fd35a3931f9d56
+  metadata.gz: 49577f6130bb371d0fe562df357da1c586e4e526
+  data.tar.gz: 0bc3a6173dafdb5b3d2dcd4c9900ab83405ddfe3
 SHA512:
-  metadata.gz: 954ac3e60846a664cfe7777f8d70307903acf292f67e00904a917592269adf1a5453ee19870beca89c3863066f0f0f58347a1ed53ce8e5cb5a9d4c4246a268c3
-  data.tar.gz: 2dc96f8639b9cbb1440d70182c5563532fa2bf7232355b133f14f34e4646fd5c12deb3f6eb8db889c06f579a3ec7cb2cd394fccafeb2935e866397b8e4b40283
+  metadata.gz: d76a3d41f7d247311ab5b514f6c72e29caa40fb0ea346016e0f8dfce2f68ffc2f2a2f9beac7300d5660387ba5da3fbd80e69aa8902014b48a40d2e7193cb5362
+  data.tar.gz: e69962785332153f623c4de95c732f3636ba32f098cb39ce98646067e9e441a1292568e0513bb65843aa0b2170cd10d42ebccd1a9234e64e25e763ec1dd5bd6d

data/README.md

@@ -2,28 +2,36 @@
 
 jekyll plugin that makes available the first image of a post in the template as a variable.
 
+By installing the plugin you will be able to access the first image of a page through `{{ @page.image }}`.
+
 This plugin is useful if you want to:
 
-*  list the posts of your jekyll site including an image 
-*  setting the twitter card image 
+*  Include an image on your list of posts
+*  Set a twitter card image for a post (see example below)
+
 
 # Install
 
-Copy `auto-image.rb` into your jekyll `_plugins` directory
+Add to your Gemfile:
 
+```
+gem 'jekyll-auto-image'
+```
+or run 
 
-# Usage
+```
+$ gem install jekyll-auto-image
+```
 
-In each post/page, the plugin will set `{{ page.image }}` following this fallback rules:
 
-1. Front matter `image` value
-2. First image in the post/page contents
-3. Default site image (defined in `_config.yml`)
-4. Nothing (false)
+Then, add to your `_config.yml`:
 
-Basically, the plugin will return the front matter image value if set. If it is not set, then it will look for the first image asset that is defined in your post content. If the post does not have any image, then it will set the site.image defined in _config.yml.
+```yaml
+gems:
+  - jekyll-auto-image
+```
 
-To set the default image for all pages/posts, add to the  `_config.yml` file the following line:
+The plugin allows you to set a default image for all pages/posts. To do that, add to your `_config.yml`:
 
 ```yaml
  # _config.yml
@@ -31,6 +39,18 @@ To set the default image for all pages/posts, add to the  `_config.yml` file the
  image: /path/to/your/default/image.png
 ```
 
+# Usage
+
+In each post/page, the plugin will set `{{ page.image }}` following this fallback rules:
+
+1. Front matter `image` value
+2. First image in the post/page contents
+3. Default site image (defined in `_config.yml`)
+4. nil
+
+Basically, the plugin will return the front matter image value if set. If it is not set, then it will look for the first image asset that is defined in your post content. If the post does not have any image, then it will set the site.image defined in _config.yml.
+
+
 ### Example of usage
 
 Example post 1:
@@ -41,7 +61,7 @@ layout: post
 title: Post 1
 ---
 
-This is my example post
+This is my example post. It includes an image in the contents.
 
 ![first image](/assets/first_image.png)
 
@@ -55,13 +75,16 @@ title: Post 2
 image: /assets/front_matter_image.png
 ---
 
-This is my example post
+This is my second example post, because the
+post includes the front matter image, the plugin 
+will return it instead of the first image in the 
+contents.
 
 ![first image](/assets/first_image.png)
 
 ```
 
-Template:
+####Template example
 
 ```liquid
 {% for post in site.posts %}
@@ -71,7 +94,7 @@ image: {{ post.image }}
 <hr>
 ```
 
-HTML output:
+#### Output HTML Rendered:
 
 ```html
 title: Post 1
@@ -85,7 +108,11 @@ image: /assets/front_matter_image.png
 ```
 ### Example using twitter cards
 
-You can define a set of `<meta>` elements in your head.html, so when sharing a post in twitter it is displayed in a cool way. You have more info in [twitter's developers page](https://dev.twitter.com/cards/types)
+Another use of this plugin is to create a [twitter card](https://dev.twitter.com/cards/getting-started).
+
+You can define a set of `<meta>` elements in your `head.html` template, so when sharing a post in twitter, the tweet displays it in cool way. You have more info in [twitter's developers page](https://dev.twitter.com/cards/types)
+
+Here you have a sample:
 
 ```html
  <!-- twitter card -->
@@ -102,10 +129,6 @@ You can define a set of `<meta>` elements in your head.html, so when sharing a p
 
 You can validate how it will look using the [cards validator](https://cards-dev.twitter.com/validator)
 
-# To Do List
-
- * Make the plugin a gem, so it can be installed using `gem install`
- * add tests cases (see [https://github.com/ivantsepp/jekyll-autolink_email](https://github.com/ivantsepp/jekyll-autolink_email))
 
 # Contributing
 
@@ -116,8 +139,12 @@ You can validate how it will look using the [cards validator](https://cards-dev.
 4. Create a new Pull Request
 
 
+The tests are based on the code of [https://github.com/ivantsepp/jekyll-autolink_email](https://github.com/ivantsepp/jekyll-autolink_email)
+
+
 # License
 
-Copyright (c) 2015 Juan M. Merlos. (@merlos) Distributed under MIT License
+Copyright (c) 2015 Juan M. Merlos. (@merlos) [www.merlos.org](http://www.merlos.org) Distributed under MIT License
+
+
 
-[www.merlos.org](http://www.merlos.org)

data/jekyll-auto-image.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jekyll/auto/image/version'
+require 'jekyll-auto-image/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-auto-image"
-  spec.version       = Jekyll::Auto::Image::VERSION
+  spec.version       = Jekyll::AutoImage::VERSION
   spec.authors       = ["merlos"]
   spec.email         = ["jmmerlos@merlos.org"]
   spec.summary       = %q{jekyll plugin that makes available the first image of a post in the template}
@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/merlos/jekyll-auto-image"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]

data/lib/{jekyll/auto/image.rb → jekyll-auto-image.rb}

@@ -1,4 +1,4 @@
-require "jekyll/auto/image/version"
+require "jekyll-auto-image/version"
 require "jekyll"
 
 module Jekyll

data/lib/jekyll-auto-image/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module AutoImage
+    VERSION = "1.0.1"
+  end
+end

data/test/helper.rb

@@ -3,4 +3,4 @@ require 'minitest/unit'
 require 'shoulda'
 require 'mocha/mini_test'
 require 'jekyll'
-require 'jekyll/auto/image'
+require 'jekyll-auto-image'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-auto-image
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - merlos
@@ -94,8 +94,8 @@ files:
 - README.md
 - Rakefile
 - jekyll-auto-image.gemspec
-- lib/jekyll/auto/image.rb
-- lib/jekyll/auto/image/version.rb
+- lib/jekyll-auto-image.rb
+- lib/jekyll-auto-image/version.rb
 - test/fixtures/_posts/contents-image.md
 - test/fixtures/contents-html.html
 - test/fixtures/contents-image.md

data/lib/jekyll/auto/image/version.rb

@@ -1,7 +0,0 @@
-module Jekyll
-  module Auto
-    module Image
-      VERSION = "1.0.0"
-    end
-  end
-end