A Liquid Filter to determine if a Jekyll Post has an excerpt to display and retrieve the excerpt to use on a list page for read more capability.
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.
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 for more detailed instructions.
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
Determines if the excerpt tag exists in the post. The return value is a boolean.
Example Usage:
{% if post.content | post_contains_excerpt_tag %}
<a href="{{ post.url }}">Read more →</a>
{% endif %}
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>
The Read More project includes a Rake file if there is a need to create a custom packaged gem for local reuse.
Available commands:
rake buildrake installrake uninstallrake version
The version numbers of this project conform to Semantic Versioning 2.0.
- 0.1.3 (2015-05-10): Fixes issue #6 caused by 0.1.1 release.
- 0.1.2 (2015-05-10): Fixes issue #5 around Gemspec date being hardcoded.
- 0.1.1 (2015-05-10): Fixes issue #1 and contains development improvements.
- 0.1.0 (2015-03-09): Initial release of gem.
This is released under the MIT license. Please see LICENSE file for more details.