jekyll-stickyposts 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2af17204ace97a1999dc4091992a8d72811c0eeb
-  data.tar.gz: 1319ca3797cb5670080e2ac2164b5d66de7b9e0a
+  metadata.gz: c6eb63684ec605e9b63c8bf7cd3352f92999034d
+  data.tar.gz: 2b975a7ea1bbf9a458f78a660e1744bb895e28e0
 SHA512:
-  metadata.gz: 2cd32659de834bb7dcfd533a39f0a452601542c3a83a6062c60608fcef61330645d14d1640e646c75e79dafbef64f25b495c253b0465f3d83b41a5c6526b3e4b
-  data.tar.gz: ec84a2520f6e6e362d86b1f28f49e61015f7c2f2c50082b69e775e42bc21a0f387f6f1a8e6daf4327514bffa0e390eda1a1a2bf37a59da54604621520f640e7c
+  metadata.gz: 24d210065cec2d9613c59e85a67cc93c4f1b0c1189673df9110d0a514e053a37f9b4a8690ee3b97d9fd197003ec31556adae27d319fcd8c0e138e3cb4c4a7c8e
+  data.tar.gz: 337c5e50321e0627c562e819ff4a857ed24b0b9081c0951846ca4605724230abacee515ffcdc235a84c02303629ef0bf0a7c7e705bcacb58cf3668b527160d4e

data/README.md

@@ -1,12 +1,13 @@
 # Jekyll::StickyPosts
 
-*Version 1.0.0*
+[![Gem Version](https://badge.fury.io/rb/jekyll-stickyposts.svg)](https://badge.fury.io/rb/jekyll-stickyposts)
 
 *StickyPosts* is a plugin for [Jekyll](https://jekyllrb.com/) that sticks/pins posts marked `sticky: true` to the top, i.e. it moves them  before all others. Optionally, the posts could also appear where they normally would.
 
 ### Why do this?
 
 1. You want to keep important announcements, etc. at the top of your home page
+1. You want descriptive entries to appear at the top of your collections
 
 ## Installation
 
@@ -38,6 +39,17 @@ stickyposts:
   sort: "blah"      # Optional sort field; default: "date", use "none" to avoid sorting
   reverse: true     # Ascending order, default: false
   retain: true      # Also show sticky posts in their original positions; default: false
+
+  #collection: articles   # The collection to "stickify"; default "posts"
+
+  # Or multiple collections:
+  #collections:
+  # - posts
+  # - articles
+
+  # Same thing:
+  #collections: ["posts", "articles"]
+
 ```
 
 > Note: if you set `sort` to `"none"` and don't sort as described in the next section, Jekyll will re-sort the documents by date. This may move the sticky posts out of position.
@@ -59,14 +71,14 @@ If you're using a paginator that allows sorting on fields, e.g. [jekyll-paginate
 pagination:
   # ...
   sort_field: "stickiness"
-  reverse: false
+  sort_reverse: false
   # ...
 
 # ...etc...
 
 stickyposts:
-  #sort: "date"   # or your original pagination sort_field
-  #reverse: true  # ditto for the pagination reverse
+  sort: "date"   # or your original pagination sort_field
+  #reverse: true  #  ditto for the sort_reverse
   # ...etc...
 ```
 
@@ -77,7 +89,7 @@ No changes will be required in your pagination setup:
 ...etc...
 {% endfor %}
 ```
-## Additional configuration
+## Miscellany
 
 You may want to mark sticky posts with e.g. a pin from [FontAwesome](http://fontawesome.io/):
 
@@ -87,6 +99,25 @@ You may want to mark sticky posts with e.g. a pin from [FontAwesome](http://font
 {% endif %}
 ```
 
+Or, if you want to put a header/descriptive post at the top of your collections:
+
+```html
+{% if post.sticky %}
+  # Formatting for the header
+{% else %}
+  # Formatting for normal entries
+{% endif %}
+```
+
+Or similarly:
+
+```html
+{% unless post.sticky %}
+  # Meta information for the entry
+{% endunless %}
+  # The rest of the entry description, e.g. excerpt
+```
+
 ## Demo
 
 See the [author's blog](https://ibrado.org/) for a (possible) demo.
@@ -113,3 +144,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 Everyone interacting in the Jekyll::StickyPosts project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-stickyposts/blob/master/CODE_OF_CONDUCT.md).
+
+## Also by the author
+
+[Jekyll Tweetsert Plugin](https://github.com/ibrado/jekyll-tweetsert) - Turn tweets into Jekyll documents. Multiple timelines, filters, hashtags, automatic category/tags, and more!

data/lib/jekyll/stickyposts.rb

@@ -29,64 +29,70 @@ module Jekyll
         return if !(config["enabled"].nil? || config["enabled"])
 
         debug = config["debug"]
-        StickyPosts::debug_state debug 
-
-        collection = config["collection"] || "posts";
+        StickyPosts::debug_state debug
 
         sort_field = config["sort"] || 'date'
         sort_reverse = config["reverse"]
 
-        sorted = site.collections[collection].docs #.clone
- 
-        unless config["sort"] == "none"
+        collections = [ config['collection'], config["collections"] ].flatten.compact;
+        collections = [ "posts" ] if collections.empty?
+
+        if config["sort"]
           StickyPosts::debug "Sorting by #{sort_field}, reverse: #{sort_reverse ? "true" : "false"}"
-          sorted.sort! { |docB, docA|
-            a = docA.data[sort_field]
-            b = docB.data[sort_field]
-
-            if a.nil? && !b.nil?
-              -1
-            elsif !a.nil? && b.nil?
-              1
-            end
+        end
 
-            if a.respond_to?('to_datetime') && b.respond_to?('to_datetime')
-              a.to_datetime <=> b.to_datetime
-            end
+        collections.each do |collection|
+          sorted = site.collections[collection].docs
 
-            a <=> b
-          }
+          unless config["sort"] == "none"
+            sorted.sort! { |docB, docA|
+              a = docA.data[sort_field]
+              b = docB.data[sort_field]
 
-          sorted.reverse! if sort_reverse
-        end
+              if a.nil? && !b.nil?
+                -1
+              elsif !a.nil? && b.nil?
+                1
+              end
 
-        remove = config["retain"].nil? || !config["retain"]
-
-        sticky = []
-        sorted.delete_if do |post|
-          if post.data['sticky']
-            StickyPosts::debug "\"#{post.data['title']}\" is sticky, #{remove ? "removing" : "retaining"} copy"
-            if remove
-              sticky << post
-            else
-              copy = Jekyll::Document.new(post.path, { :site => site, :collection => site.posts })
-              copy.merge_data!(post.data)
-              sticky << copy
-            end
-            remove
+              if a.respond_to?('to_datetime') && b.respond_to?('to_datetime')
+                a.to_datetime <=> b.to_datetime
+              end
+
+              a <=> b
+            }
+
+            sorted.reverse! if sort_reverse
           end
-        end
 
-        sorted.unshift(*sticky)
+          remove = config["retain"].nil? || !config["retain"]
+
+          sticky = []
+          sorted.delete_if do |doc|
+            if doc.data['sticky']
+              StickyPosts::debug "\"#{doc.data['title']}\" is sticky, #{remove ? "removing" : "retaining"} copy"
+              if remove
+                sticky << doc
+              else
+                copy = Jekyll::Document.new(doc.path, { :site => site,
+                  :collection => site.collections[collection]})
+                copy.merge_data!(doc.data)
+                sticky << copy
+              end
+              remove
+            end
+          end
 
-        order = 0;
-        sorted.each do |post|
-          post.data["stickiness"] = order
-          order += 1
-        end
+          sorted.unshift(*sticky)
 
-        StickyPosts::info "#{sticky.length} post(s) pinned"
+          order = 0;
+          sorted.each do |doc|
+            doc.data["stickiness"] = order
+            order += 1
+          end
 
+          StickyPosts::info "[#{collection}] #{sticky.length} post(s) pinned"
+        end
       end
     end
   end

data/lib/jekyll/stickyposts/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module StickyPosts
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-stickyposts
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alex Ibrado
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-13 00:00:00.000000000 Z
+date: 2017-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll