Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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 json tags yaml
Last synced: 14 days 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 (10 months ago)
- Default Branch: main
- Last Pushed: 2024-04-23T13:52:38.000Z (9 months ago)
- Last Synced: 2025-01-07T23:47:46.843Z (20 days ago)
- Topics: categories, jekyll, json, tags, yaml
- Language: Ruby
- Homepage: https://github.com/pirafrank/jekyll-listme
- Size: 26.4 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
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
```Gemfile
gem 'jekyll-listme', git: 'https://github.com/pirafrank/jekyll-listme', branch: 'main'
```
## 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 and pull requests are welcome on GitHub at https://github.com/pirafrank/jekyll-listme.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).