Jekyll ListMe

A Jekyll command plugin to list and count data in your Jekyll website. List tags, categories, and more, and count their occurrencies. Choose among various output formats.

Installation

1. Add the plugin to you Jekyll site's Gemfile in the :jekyll_plugins group:

group :jekyll_plugins do
  gem 'jekyll-listme'
end

2. Run bundle install

From git

Alternatively, you can get code straight from this repository. Code from main branch should be stable enough but may contain unreleased software with bugs or breaking changes. Unreleased software should be considered of beta quality.

group :jekyll_plugins do
  gem 'jekyll-listme', git: 'https://github.com/pirafrank/jekyll-listme', branch: 'main'
end

Update

bundle update jekyll-listme

Usage

Plain text is the default output format:

bundle exec jekyll list tags
bundle exec jekyll list categories

You can choose an output format like this:

bundle exec jekyll list tags --output FORMAT
bundle exec jekyll list categories --output FORMAT

You can also count items, instead of listing them:

bundle exec jekyll list --count tags --output FORMAT
bundle exec jekyll list --all --output FORMAT

Supported formats are:

• plain
• json
• yaml
• csv
• tsv
• psv

Development

Clone and run bundle install to get started.

Code lives in lib/jekyll/commands and is referenced with require in lib/jekyll/listme.rb. To experiment with that code, run bundle exec jekyll list from a Jekyll site with this gem added as plugin. Read more on Jekyll's Commands documentation.

I got the first steps to create the template from here.

Contributing

Bug reports and pull requests are welcome on GitHub.

Guarantee

This plugin is provided as is, without any guarantee. Use at your own risk.

License

The gem is available as open source under the terms of the MIT License.