Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ibrado/jekyll-stickyposts
Jekyll Stickyposts - move selected posts to the top of the list
https://github.com/ibrado/jekyll-stickyposts
jekyll jekyll-plugin pinned pinned-posts priority priority-posts sticky sticky-posts
Last synced: 3 months ago
JSON representation
Jekyll Stickyposts - move selected posts to the top of the list
- Host: GitHub
- URL: https://github.com/ibrado/jekyll-stickyposts
- Owner: ibrado
- License: mit
- Created: 2017-12-13T22:31:03.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-06T04:49:56.000Z (almost 7 years ago)
- Last Synced: 2024-09-28T18:08:13.572Z (4 months ago)
- Topics: jekyll, jekyll-plugin, pinned, pinned-posts, priority, priority-posts, sticky, sticky-posts
- Language: Ruby
- Homepage:
- Size: 23.4 KB
- Stars: 23
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Jekyll::StickyPosts
[](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
## What's new?
*v1.2.2* Allow inclusion in `_config.yml` plugins
*v1.2.1* Fix sorting
*v1.2.0* Add `reverse_sticky` option
*v1.1.0* Support multiple collections
## Installation
Add the gem to your application's Gemfile:
```ruby
group :jekyll_plugins do
# other plugins here
gem 'jekyll-stickyposts'
end
```
And then execute:
$ bundle
Or install it yourself:
$ gem install jekyll-stickyposts
## Configuration
No configuration is required to run *StickyPosts*. If you want to tweak its behavior, you may set the following options in `_config.yml`:
```yaml
stickyposts:
#enabled: false # Enable StickyPosts; default: true
debug: true # Show additional info; default: false
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
reverse_sticky: true # Reverse the order of the sticky posts, e.g. oldest first; 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 will likely move the sticky posts out of position.
## Usage
Just add a `sticky: true` entry to your front matter:
```yaml
---
title: Test
date: 2017-12-15 22:33:44
sticky: true
---
```
If you're not using a paginator at all, use something like:
```html
{% assign sorted = site.posts | sort: "stickiness" %}
{% for post in sorted %}
...etc...
{% endfor %}
```
If you're using the original jekyll-paginate:
```html
{% assign sorted = paginator.posts | sort: "stickiness" %}
{% for post in sorted %}
...etc...
{% endfor %}
```
If you're using a paginator that allows sorting on fields, e.g. [jekyll-paginate-v2](https://github.com/sverrirs/jekyll-paginate-v2/), you need to edit your `_config.yml` a bit:
```yaml
pagination:
# ...
sort_field: "stickiness"
sort_reverse: false
# ...
# ...etc...
stickyposts:
sort: "date" # or your original pagination sort_field
#reverse: true # ditto for the sort_reverse
# ...etc...
```
No changes will be required in your pagination setup:
```html
{% for post in paginator.posts %}
...etc...
{% endfor %}
```
## Miscellany
You may want to mark sticky posts with e.g. a pin from [FontAwesome](http://fontawesome.io/):
```html
{% if post.sticky %}
{% 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.
## Contributing
1. Fork this project: [https://github.com/ibrado/jekyll-stickyposts/fork](https://github.com/ibrado/jekyll-stickyposts/fork)
1. Clone it (`git clone git://github.com/your_user_name/jekyll-stickyposts.git`)
1. `cd jekyll-stickyposts`
1. Create a new branch (e.g. `git checkout -b my-bug-fix`)
1. Make your changes
1. Commit your changes (`git commit -m "Bug fix"`)
1. Build it (`gem build jekyll-stickyposts.gemspec`)
1. Install and test it (`gem install ./jekyll-stickyposts-*.gem`)
1. Repeat from step 5 as necessary
1. Push the branch (`git push -u origin my-bug-fix`)
1. Create a Pull Request, making sure to select the proper branch, e.g. `my-bug-fix` (via https://github.com/*your_user_name*/jekyll-stickyposts)
Bug reports and pull requests are welcome on GitHub at [https://github.com/ibrado/jekyll-stickyposts](https://github.com/ibrado/jekyll-stickyposts). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## 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 posts. Multiple timelines, filters, hashtags, automatic category/tags, and more!
[Jekyll::Paginate::Content](https://github.com/ibrado/jekyll-tweetsert) - Split your Jekyll pages, posts, etc. into multiple pages automatically. Single-page view, pager, SEO support, self-adjusting links, multipage-aware Table Of Contents.
[Jekyll::ViewSource](https://github.com/ibrado/jekyll-viewsource) - Generate pretty or plain HTML and/or Markdown source code pages.