{"id":13612140,"url":"https://github.com/imgix/jekyll-imgix","last_synced_at":"2025-04-13T11:31:40.104Z","repository":{"id":54781918,"uuid":"44643029","full_name":"imgix/jekyll-imgix","owner":"imgix","description":"A plugin for integrating imgix into Jekyll sites","archived":true,"fork":false,"pushed_at":"2023-08-14T20:35:24.000Z","size":38,"stargazers_count":51,"open_issues_count":0,"forks_count":9,"subscribers_count":17,"default_branch":"main","last_synced_at":"2024-04-24T16:58:59.997Z","etag":null,"topics":["images","imgix","jekyll","jekyll-plugin","signing-imgix-urls","src","srcset","url-builder"],"latest_commit_sha":null,"homepage":"https://www.imgix.com","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/imgix.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2015-10-21T00:33:38.000Z","updated_at":"2023-08-14T20:39:16.000Z","dependencies_parsed_at":"2024-01-14T04:49:42.397Z","dependency_job_id":"fc0e18c9-fcd2-4047-b8ac-b0689a064dfc","html_url":"https://github.com/imgix/jekyll-imgix","commit_stats":{"total_commits":30,"total_committers":10,"mean_commits":3.0,"dds":0.7333333333333334,"last_synced_commit":"0a8049046733078c7667e5bd33a4a6a4853b3b47"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imgix%2Fjekyll-imgix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imgix%2Fjekyll-imgix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imgix%2Fjekyll-imgix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imgix%2Fjekyll-imgix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imgix","download_url":"https://codeload.github.com/imgix/jekyll-imgix/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248705670,"owners_count":21148574,"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":["images","imgix","jekyll","jekyll-plugin","signing-imgix-urls","src","srcset","url-builder"],"created_at":"2024-08-01T20:00:23.277Z","updated_at":"2025-04-13T11:31:39.788Z","avatar_url":"https://github.com/imgix.png","language":"Ruby","funding_links":[],"categories":["Images \u0026 Pictures"],"sub_categories":[],"readme":"\u003c!-- ix-docs-ignore --\u003e\n\n\u003e [DEPRECATED]\n\u003e \n\u003e _This project has reached the end of its development._\n\u003e _Feel free to browse the code, but please use other solutions for integrating imgix into your Jekyll projects._\n\n![imgix logo](https://assets.imgix.net/sdk-imgix-logo.svg)\n\n`jekyll-imgix` is a plugin for integrating [imgix](https://www.imgix.com) into Jekyll sites.\n[![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)\n[![Gem Version](https://img.shields.io/gem/v/jekyll-imgix.svg)](https://rubygems.org/gems/jekyll-imgix)\n![Downloads](https://img.shields.io/gem/dt/jekyll-imgix)\n\n---\n\u003c!-- /ix-docs-ignore --\u003e\n\n- [Installation](#installation)\n- [Configuration](#configuration)\n    * [Multi-source configuration](#multi-source-configuration)\n- [Usage](#usage)\n    * [Multi-source usage](#multi-source-usage)\n- [Contributing](#contributing)\n- [Code of Conduct](#code-of-conduct)\n- [License](#license)\n\n## Installation\n\nFirst, add `liquid` and `jekyll-imgix` to the `:jekyll_plugins` group in your Gemfile:\n\n```rb\ngroup :jekyll_plugins do\n  gem 'rouge'\n  gem 'kramdown'\n  gem 'liquid'\n  gem 'jekyll-imgix'\nend\n```\n\nThen include `jekyll-imgix` in the `plugins:` section of your `_config.yml` file:\n\n``` yaml\nplugins: [jekyll/imgix]\n```\n\n## Configuration\n\njekyll-imgix requires a configuration block in your `_config.yml`:\n\n```yaml\nimgix:\n  source: assets.imgix.net # Your imgix source address\n  secure_url_token: FACEBEEF12 # (optional) The Secure URL Token associated with your source\n  include_library_param: true  # (optional) If `true` all the URLs will include `ixlib` parameter\n```\n\n### Multi-source configuration\n\nIn addition to the standard configuration flags, the following options can be used to serve images across different sources.\n\n```yaml\nimgix:\n  sources:  # imgix source-secure_url_token key-value pairs.\n    assets.imgix.net: FACEBEEF12\n    assets2.imgix.net:            # Will generate unsigned URLs\n  default_source: assets.imgix.net  # (optional) specify a default source for generating URLs.\n```\n\nNote: `sources` and `source` *cannot* be used together.\n\n## Usage\n\n**jekyll-imgix does not do anything unless JEKYLL_ENV is set to production**. For example,\nyou will want to run `JEKYLL_ENV=production jekyll build` before deploying your site to\nproduction.\n\njekyll-imgix exposes its functionality as a single Jekyll Filter, `imgix_url`.\n\nPass an existing image path to it to activate it:\n\n```html\n\u003cimg src={{ \"/images/bear.jpg\" | imgix_url }} /\u003e\n```\n\nThat will generate the following HTML in your output:\n\n```html\n\u003cimg src=\"https://assets.imgix.net/images/bear.jpg\" /\u003e\n```\n\nYou can also pass parameters to the `imgix_url` helper like so:\n\n```html\n\u003cimg src={{ \"/images/bear.jpg\" | imgix_url: w: 400, h: 300 }} /\u003e\n```\n\nWhich would result in the following HTML:\n\n```html\n\u003cimg src=\"https://assets.imgix.net/images/bear.jpg?w=400\u0026h=300\" /\u003e\n```\n\n### Multi-source usage\n\nTo use jekyll-imgix in a multi-source setup:\n\n```html\n\u003cimg src={{ \"/images/bear.jpg\" | imgix_url: \"assets2.imgix.net\", w: 400, h: 300 }} /\u003e\n\u003cimg src={{ \"/images/bear.jpg\" | imgix_url: w: 400, h: 300 }} /\u003e  \u003c!-- will use default_source from config --\u003e\n```\n\nWhich would generate:\n\n```html\n\u003cimg src=\"https://assets2.imgix.net/images/bear.jpg?w=400\u0026h=300\" /\u003e\n\u003cimg src=\"https://assets.imgix.net/images/bear.jpg?w=400\u0026h=300\" /\u003e\n```\n\nIn absence of correctly configured `default_source`, `imgix_url` will report `RuntimeError` if it's used without specifying a valid source.\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/imgix/jekyll-imgix.\n\n## Code of Conduct\nUsers contributing to or participating in the development of this project are subject to the terms of imgix's [Code of Conduct](https://github.com/imgix/code-of-conduct).\n\n## License\n[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fimgix%2Fjekyll-imgix.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fimgix%2Fjekyll-imgix?ref=badge_large)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimgix%2Fjekyll-imgix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimgix%2Fjekyll-imgix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimgix%2Fjekyll-imgix/lists"}