Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mslinn/jekyll_nth
Liquid filter that returns item n of a Ruby array, origin 1.
https://github.com/mslinn/jekyll_nth
array jekyll jekyll-filter jekyll-plugin
Last synced: about 1 month ago
JSON representation
Liquid filter that returns item n of a Ruby array, origin 1.
- Host: GitHub
- URL: https://github.com/mslinn/jekyll_nth
- Owner: mslinn
- License: mit
- Created: 2022-03-18T17:58:22.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-11T21:37:35.000Z (about 1 year ago)
- Last Synced: 2024-03-14T15:51:12.595Z (9 months ago)
- Topics: array, jekyll, jekyll-filter, jekyll-plugin
- Language: Ruby
- Homepage: https://www.mslinn.com/jekyll_plugins/jekyll_nth.html
- Size: 53.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-jekyll-plugins - **jekyll_nth**
README
# `jekyll_nth` [](https://badge.fury.io/rb/jekyll_nth)
`jekyll_nth` provides two Jekyll filter plugin that manipulate arrays.
* `nth` returns item `n` of the array, origin 0.
* `tail` returns the remainder of the array after the first element.
## Usage
```html
{{ [1, 2, 3, 4, 5] | nth: 2 }} # returns 3
{{ [1, 2, 3, 4, 5] | nth: -1 }} # returns 5
{{ [1, 2, 3, 4, 5] | nth: 99 }} # throws exception
```
:warning: Important: the name of the filter must be followed by a colon (:). If you fail to do that an error will be generated and the Jekyll site building process will halt. The error message looks something like this: `Liquid Warning: Liquid syntax error (line 285): Expected end_of_string but found string in "{{ [1, 2, 3, 4, 5] | nth: '2' }}" in /some_directory/some_files.html Liquid Exception: Liquid error (line 285): wrong number of arguments (given 1, expected 2) in /some_directory/some_file.html Error: Liquid error (line 285): wrong number of arguments (given 1, expected 2)`
```html
{{ [1, 2, 3, 4, 5] | tail }} # returns [2, 3, 4, 5]
{{ [1] | tail }} # returns []
{{ [] | tail }} # throws exception
```
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'jekyll_nth'
```
And then execute:
```shell
$ bundle
```
## Additional Information
More information is available on
[Mike Slinn’s website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
## 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.
### Build and Install Locally
To build and install this gem onto your local machine, run:
```shell
$ bundle exec rake install
jekyll_nth 1.0.0 built to pkg/jekyll_nth-0.1.0.gem.
jekyll_nth (1.0.0) installed.
```
Examine the newly built gem:
```shell
$ gem info jekyll_nth
*** LOCAL GEMS ***
jekyll_nth (1.0.0)
Author: Mike Slinn
Homepage:
https://github.com/mslinn/jekyll_nth
License: MIT
Installed at: /home/mslinn/.gems
Generates Jekyll logger with colored output.
```
### Build and Push to RubyGems
To release a new version,
1. Update the version number in `version.rb`.
2. Commit all changes to git; if you don't the next step might fail with an unexplainable error message.
3. Run the following:
```shell
$ bundle exec rake release
```
The above creates a git tag for the version, commits the created tag,
and pushes the new `.gem` file to [RubyGems.org](https://rubygems.org).
## Contributing
1. Fork the project
2. Create a descriptively named feature branch
3. Add your feature
4. Submit a pull request
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).