{"id":15288485,"url":"https://github.com/skatkov/jekyll-heroicons","last_synced_at":"2025-09-10T08:41:44.181Z","repository":{"id":257788876,"uuid":"860685467","full_name":"skatkov/jekyll-heroicons","owner":"skatkov","description":"Heroicons as a liquid tag for Jekyll.","archived":false,"fork":false,"pushed_at":"2025-02-10T10:42:17.000Z","size":424,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T11:02:17.728Z","etag":null,"topics":["heroicons","jekyll","tailwindcss"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/skatkov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-20T23:34:25.000Z","updated_at":"2025-02-10T10:42:11.000Z","dependencies_parsed_at":"2024-09-21T12:11:39.357Z","dependency_job_id":"ea8aa5ff-bd78-45f3-96bc-ba1f7f944864","html_url":"https://github.com/skatkov/jekyll-heroicons","commit_stats":null,"previous_names":["skatkov/jekyll-heroicons"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skatkov%2Fjekyll-heroicons","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skatkov%2Fjekyll-heroicons/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skatkov%2Fjekyll-heroicons/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skatkov%2Fjekyll-heroicons/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/skatkov","download_url":"https://codeload.github.com/skatkov/jekyll-heroicons/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248681493,"owners_count":21144700,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["heroicons","jekyll","tailwindcss"],"created_at":"2024-09-30T15:49:36.435Z","updated_at":"2025-04-13T07:52:27.009Z","avatar_url":"https://github.com/skatkov.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jekyll-heroicons\n\nJekyll liquid tags for the beautiful hand-crafted SVG icons, Heroicons.\n\nThis gem has no official affiliation with Tailwind CSS or the Heroicons team. Check out their sites:\n\n- [Tailwind CSS](https://tailwindcss.com/)\n- [Tailwind UI](https://tailwindui.com/)\n- [Heroicons](https://heroicons.com/)\n\nThis is heavily inspired by https://github.com/jclusso/heroicons\n\nIf you are looking to build a Jekyll website with Tailwind and no-build, take a look at [Jekyll CLI Template](https://github.com/skatkov/jekyll-tailwind-cli-template) that contains already this gem.\n\n## Installation\n\n1. Add this to `Gemfile`:\n\n  ```ruby\n  gem 'jekyll-heroicons'\n  ```\n2. Add this to your jekyll `_config.yml`:\n\n  ```yaml\n  plugins:\n    - jekyll-heroicons\n  ```\n\n## Usage\n```liquid\n{% heroicon bell %}\n```\nHeroicons comes in 4 variants: `solid`, `outline`, `mini`, and `micro`. The default variant is `solid`.\nThis can be changed through configuration in `_config.yml`:\n\n```ruby\nheroicons:\n  variant: 'solid'\n```\n\nAnother way to provide variant and override defaults defined in config is to pass 'variant' to liquid tag:\n```liquid\n{% heroicon bell variant: \"mini\" %}\n```\n\nIt's also possible to provide classes to the icon:\n```liquid\n{% heroicon bell class: \"text-red-500\" %}\n```\n\nAny other attributes will be passed to the SVG tag as well. As example:\n\n```liquid\n{% heroicon bell class: \"text-red-500\" aria-hidden: true height:32 aria-label:hi %}\n```\n## Configuration\nBesides variants, it's also possible to define default classes for each variant. Here is a recommended default configuration for `_config.yml`:\n\n```ruby\nheroicons:\n  variant: 'solid'\n  default_class: {\n    solid: \"size-6\",\n    outline: \"size-6\",\n    mini: \"size-5\",\n    micro: \"size-4\",\n  }\n```\n\nThis default class will be applied to every icon. You can disable this on a per-icon basis by passing `disable_default_class: true`.\n\n```liquid\n{% heroicon bell disable_default_class: true %}\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/skatkov/jekyll-heroicons. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/skatkov/jekyll-heroicons/blob/master/CODE_OF_CONDUCT.md).\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone interacting in the Jekyll::Heroicons project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/skatkov/jekyll-heroicons/blob/master/CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskatkov%2Fjekyll-heroicons","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskatkov%2Fjekyll-heroicons","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskatkov%2Fjekyll-heroicons/lists"}