jekyll-read-more 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc80ff58409b3d21e9b76f69c2576cddc764b332
+  data.tar.gz: 27729aa24c85b99f1a0af90d2ebc25c347e4917c
+SHA512:
+  metadata.gz: 37958bb19efc461b87b0abe8b9a840a09d81f49d8d3ea996c51c19b3c691a313ac39add9eec4c4e8ce7a3bb9435bcc195b339a09afc7dbf6e2942db1b56049da
+  data.tar.gz: 2372001c6856748df7c2ca42e73a096444faa19295e62adacd2765a3cd6bc28bf9371d9751e8cf38f0becbf61eea7424b4114724f0d3536f07df28e39284e113

data/LICENSE

@@ -0,0 +1,10 @@
+The MIT License
+
+Copyright © 2015, Rob Shaw.
+
+This software is released under the following version of the MIT license:
+
+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 condition: 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,57 @@
+# Read More Plugin for Jekyll
+
+A [Liquid Filter](http://liquidmarkup.org/) to determine if a [Jekyll](http://jekyllrb.com/) Post has an excerpt to display and retrieve the excerpt to use on a list page for read more capability.
+
+## Installation
+
+The easiest way to install this plugin is with RubyGems: `gem install jekyll-read-more`.
+
+You can see the gem on Ruby Gems: [jekyll-read-more](https://rubygems.org/gems/jekyll-read-more).
+
+This Liquid Filter is designed specifically for Jekyll. This plugin can be installed directly to the `_plugins/` directory by dropping the contents of the `lib` directory into the `_plugins` folder.
+
+See [documentation on installing Jekyll plugins](http://jekyllrb.com/docs/plugins/#installing-a-plugin) for more detailed instructions.
+
+## Usage
+
+In any post where an excerpt should be used to display elsewhere, include the following tag `<!---excerpt-break-->` after the content that should be displayed as the excerpt.
+
+_Please note that the tag has three dashes (-) after the bang (!). This is to support HTML comments in markdown._
+
+Two methods are provided via Liquid Filters:
+
+* post\_contains\_excerpt\_tag?
+* get\_post\_excerpt
+
+### post\_contains\_excerpt\_tag?
+
+Determines if the excerpt tag exists in the post. The return value is a boolean.
+
+Example Usage:
+
+    {% if post.content | post_should_be_truncated? %}
+      <a href="{{ post.url }}">Read more →</a>
+    {% endif %}
+
+### get\_post\_excerpt
+
+Will remove all content from the excerpt tag and after. The return value will be a string.
+
+If the excerpt tag cannot be found, it will perform no action.
+
+Example Usage:
+
+    <p class="excerpt">
+      {{ post.content | get_post_excerpt }}
+    </p>
+    
+## Versioning
+
+The version numbers of this project conform to [Semantic Versioning 2.0](http://semver.org/).
+
+* __0.1.0__ (2015-03-09): Initial release of gem.
+
+## License
+
+This is released under the MIT license. Please see LICENSE file for more details.
+

data/jekyll-read-more.gemspec

@@ -0,0 +1,23 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require 'jekyll-read-more/version'
+
+Gem::Specification.new do |gem_spec|
+  gem_spec.name         = 'jekyll-read-more'
+  gem_spec.version      = Jekyll::ReadMore::VERSION
+  gem_spec.date         = '2015-03-09'
+
+  gem_spec.summary      = 'A Liquid Filter to get an excerpt from a Jekyll Post.'
+  gem_spec.description  = 'A Liquid Filter to determine if a Jekyll Post has an excerpt to display and get the excerpt.'
+
+  gem_spec.authors      = ['Rob Shaw']
+  gem_spec.email        = ['rob@borwahs.com']
+  gem_spec.homepage     = 'https://github.com/borwahs/jekyll-read-more/'
+  gem_spec.license      = 'MIT'
+
+  gem_spec.files        = Dir["./**/*"].reject{|file| file =~ /\.\/(doc|pkg|spec|test)/}
+  gem_spec.require_path = 'lib'
+
+  gem_spec.add_runtime_dependency 'liquid'
+  gem_spec.add_development_dependency 'jekyll'
+end

data/lib/jekyll-read-more.rb

@@ -0,0 +1,2 @@
+require 'jekyll-read-more/filter'
+require 'jekyll-read-more/version'

data/lib/jekyll-read-more/filter.rb

@@ -0,0 +1,43 @@
+# jekyll-read-more
+#
+# A Liquid Filter for Jekyll to check and retrieve
+# an excerpt from a post.
+#
+# https://github.com/borwahs/jekyll-post-excerpt
+#
+# Copyright (c) Rob Shaw, 2015
+# See readme.md for LICENSE information.
+
+module Jekyll
+  module ReadMore
+    module Filter
+      extend self
+
+      # uses the markdown format <!--- (three dashes)
+      EXCERPT_BREAK_TAG = "<!---excerpt-break-->"
+
+      def post_contains_excerpt_tag?(post)
+        post.include?(EXCERPT_BREAK_TAG)
+      end
+
+      def get_post_excerpt(post)
+        if !post_contains_excerpt_tag?(post)
+          return post
+        end
+
+        post_split = post.split(EXCERPT_BREAK_TAG)
+
+        strip_footnotes(post_split[0])
+      end
+
+      def strip_footnotes(content)
+        # Example: <sup>...</sup>
+        # Regex: <sup>.*?<\/sup>/mi
+
+        content.gsub(/<sup>.*?<\/sup>/mi, '')
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::ReadMore::Filter) if defined?(Liquid)

data/lib/jekyll-read-more/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module ReadMore
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-read-more
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Shaw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Liquid Filter to determine if a Jekyll Post has an excerpt to display
+  and get the excerpt.
+email:
+- rob@borwahs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./LICENSE
+- ./README.md
+- ./jekyll-read-more-0.1.0.gem
+- ./jekyll-read-more.gemspec
+- ./lib/jekyll-read-more.rb
+- ./lib/jekyll-read-more/filter.rb
+- ./lib/jekyll-read-more/version.rb
+homepage: https://github.com/borwahs/jekyll-read-more/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Liquid Filter to get an excerpt from a Jekyll Post.
+test_files: []