https://github.com/pirafrank/jekyll-listme
A Jekyll command plugin to list tags and categories for your Jekyll website. Output as plain text, JSON, or YAML.
https://github.com/pirafrank/jekyll-listme
categories jekyll jekyll-plugin jekyll-plugins json plugins tags yaml
Last synced: 3 months ago
JSON representation
A Jekyll command plugin to list tags and categories for your Jekyll website. Output as plain text, JSON, or YAML.
- Host: GitHub
- URL: https://github.com/pirafrank/jekyll-listme
- Owner: pirafrank
- License: mit
- Created: 2024-03-20T22:47:56.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-24T12:19:58.000Z (3 months ago)
- Last Synced: 2025-02-28T22:10:29.293Z (3 months ago)
- Topics: categories, jekyll, jekyll-plugin, jekyll-plugins, json, plugins, tags, yaml
- Language: Ruby
- Homepage: https://rubygems.org/gems/jekyll-listme
- Size: 42 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
README
# Jekyll ListMe
[](https://rubygems.org/gems/jekyll-listme)
[](https://github.com/pirafrank/jekyll-listme/releases/latest)
[](https://opensource.org/licenses/MIT)
A [Jekyll](https://jekyllrb.com/) [command](https://jekyllrb.com/docs/plugins/commands/) 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:
```Gemfile
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.
```Gemfile
group :jekyll_plugins do
gem 'jekyll-listme', git: 'https://github.com/pirafrank/jekyll-listme', branch: 'main'
end
```
## Update
```sh
bundle update jekyll-listme
```
## Usage
Plain text is the default output format:
```sh
bundle exec jekyll list tags
bundle exec jekyll list categories
```
You can choose an output format like this:
```sh
bundle exec jekyll list tags --output FORMAT
bundle exec jekyll list categories --output FORMAT
```
You can also count items, instead of listing them:
```sh
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](https://jekyllrb.com/docs/plugins/commands/).
I got the first steps to create the template from [here](https://maxchadwick.xyz/blog/building-a-custom-jekyll-command-plugin).
## Contributing
[Bug reports](https://github.com/pirafrank/jekyll-listme/issues) and [pull requests](https://github.com/pirafrank/jekyll-listme/pulls) 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](https://opensource.org/licenses/MIT).