This is a Jekyll plugin that provides two Liquid filters: basename
and dirname
.
They work like the similarly named bash commands.
More information is available on my web site about my Jekyll plugins.
Installation
Add this line to your Jekyll website's Gemfile
, within the jekyll_plugins
group:
group :jekyll_plugins do
gem 'jekyll_basename_dirname'
end
And then execute:
$ bundle install
Or install it yourself as:
$ gem install jekyll_basename_dirname
Usage
Dirname
Filters a string containing a path and returns the portion of th path before the filename and extension. Example: Extracts "blah/blah" from the path.
{{ "blah/blah/filename.ext" | dirname }} => blah/blah
Basename
Filters a string containing a path and returns the filename extracted from the path, including the filetype.
Example: Extracts "filename.ext" from the path:
{{ "blah/blah/filename.ext" | basename }} => filename.ext
Basename Without Extension
Filters a string containing a path and returns the filename extracted from the path, including the filetype.
Example: Extracts "filename.ext" from the path:
{{ "blah/blah/filename.ext" | basename_without_extension }} => filename
Development
After checking out the repo, run bin/setup
to install dependencies. You can also run bin/console
for an interactive prompt that will allow you to experiment.
Install development dependencies like this:
$ BUNDLE_WITH="development" bundle install
To install this gem onto your local machine, run:
$ bundle exec rake install
To release a new version,
- Update the version number in
version.rb
. - Commit all changes to git; if you don't the next step might fail with an unexplainable error message.
- Run the following:
The above creates a git tag for the version, commits the created tag, and pushes the new
$ bundle exec rake release
.gem
file to RubyGems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/mslinn/jekyll_basename_dirname.
License
The gem is available as open source under the terms of the MIT License.