{"id":13612068,"url":"https://github.com/algolia/jekyll-algolia","last_synced_at":"2025-06-19T15:43:49.316Z","repository":{"id":27069642,"uuid":"109850487","full_name":"algolia/jekyll-algolia","owner":"algolia","description":"Add fast and relevant search to your Jekyll site","archived":false,"fork":false,"pushed_at":"2023-10-27T00:29:04.000Z","size":34111,"stargazers_count":217,"open_issues_count":38,"forks_count":36,"subscribers_count":64,"default_branch":"main","last_synced_at":"2025-04-25T11:53:18.661Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://community.algolia.com/jekyll-algolia/","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/algolia.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2017-11-07T15:01:04.000Z","updated_at":"2025-04-08T07:50:36.000Z","dependencies_parsed_at":"2024-06-18T13:56:05.245Z","dependency_job_id":"9f198b9b-1392-42fa-8e6b-d94ab5694b57","html_url":"https://github.com/algolia/jekyll-algolia","commit_stats":{"total_commits":608,"total_committers":17,"mean_commits":35.76470588235294,"dds":"0.10032894736842102","last_synced_commit":"3c08877e031ce1ded148aa8c03cefffcc9084c73"},"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"purl":"pkg:github/algolia/jekyll-algolia","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Fjekyll-algolia","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Fjekyll-algolia/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Fjekyll-algolia/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Fjekyll-algolia/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/algolia","download_url":"https://codeload.github.com/algolia/jekyll-algolia/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Fjekyll-algolia/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260781673,"owners_count":23062282,"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":[],"created_at":"2024-08-01T20:00:21.994Z","updated_at":"2025-06-19T15:43:44.301Z","avatar_url":"https://github.com/algolia.png","language":"Ruby","funding_links":[],"categories":["Ruby","Search","Community Integrations"],"sub_categories":[],"readme":"# DEPRECATED\n\nThis plugin is deprecated and no longer maintained by Algolia.\n\nAs of November 2022, it still works on Jekyll 3. Issues are still open, as a\nplace to discuss, but Pull Requests will be closed.\n\nIf you're interested in becoming a maintainer and giving it a second life, feel\nfree to fork it (or get in touch with @Algolia to become an official\nmaintainer).\n\nBelow is the old README, for archiving purposes:\n\n---\n\n## Jekyll Algolia Plugin\n\n[![No Maintenance Intended][19]][7] [![gem version][1]][16] ![ruby][2]\n![jekyll][3] [![build master][4]][17] [![build develop][6]][17]\n[![coverage master][5]][18]\n\nAdd fast and relevant search to your Jekyll site.\n\n### Usage\n\n```shell\n$ bundle exec jekyll algolia\n```\n\nThis will push the content of your Jekyll website to your Algolia index.\n\n### Documentation\n\nFull documentation can be found on\n[https://community.algolia.com/jekyll-algolia/][20]\n\n### Installation\n\nThe plugin requires at least Jekyll 3.6.0 and Ruby 2.3.0.\n\nFirst, add the `jekyll-algolia` gem to your `Gemfile`, in the `:jekyll_plugins`\nsection.\n\n```ruby\n# Gemfile\n\ngroup :jekyll_plugins do\n  gem 'jekyll-algolia', '~\u003e 1.0'\nend\n```\n\nOnce this is done, download all dependencies with `bundle install`.\n\n### Basic configuration\n\nYou need to provide certain Algolia credentials for this plugin to _index_ your\nsite.\n\n_If you don't yet have an Algolia account, we suggest that you open a free\n[Community plan here][8]. You can find more information about the Algolia plans\n[in our FAQ][10]._\n\nOnce signed in, you should get your application ID from [your dashboard][9] and\ndefine it inside your `_config.yml` file like this:\n\n```yaml\n# _config.yml\n\nalgolia:\n  application_id: 'your_application_id'\n```\n\n### Run it\n\nOnce your application ID is setup, you can run the indexing by running the\nfollowing command:\n\n```shell\nALGOLIA_API_KEY='your_admin_api_key' bundle exec jekyll algolia\n```\n\nNote that `ALGOLIA_API_KEY` should be set to your admin API key.\n\n### More about the Community plan\n\nThe Algolia [Community plan][11] lets you host up to 10k records and perform up\nto 100k add/edit/delete operations per month (search operations are free). The\nplan is entirely free, with no time limit.\n\nWhat we ask in exchange is that you display a \"Search by Algolia\" logo next to\nyour search results. Our [InstantSearch libraries][12] have a boolean option to\ntoggle that on an off. If you want more flexibility, you can find all versions\nof our logo [here][13].\n\nIf you need more information about the other Algolia plans, you can [check our\nFAQ][10].\n\n## Thanks\n\nThanks to [Anatoliy Yastreb][14] for a [great tutorial][15] on creating Jekyll\nplugins.\n\n[1]: https://badge.fury.io/rb/jekyll-algolia.svg\n[2]: https://img.shields.io/badge/ruby-%3E%3D%202.3.0-green.svg\n[3]: https://img.shields.io/badge/jekyll-%3E%3D%203.6.0-green.svg\n[4]:\n  https://img.shields.io/badge/dynamic/json.svg?label=build%3Amaster\u0026query=value\u0026uri=https%3A%2F%2Fimg.shields.io%2Ftravis%2Falgolia%2Fjekyll-algolia.json%3Fbranch%3Dmaster\n[5]:\n  https://coveralls.io/repos/github/algolia/jekyll-algolia/badge.svg?branch=master\n[6]:\n  https://img.shields.io/badge/dynamic/json.svg?label=build%3Adevelop\u0026query=value\u0026uri=https%3A%2F%2Fimg.shields.io%2Ftravis%2Falgolia%2Fjekyll-algolia.json%3Fbranch%3Ddevelop\n[8]: #more-about-the-community-plan\n[9]: https://www.algolia.com/api-keys\n[10]:\n  https://community.algolia.com/jekyll-algolia/faq.html#how-many-records-will-the-plugin-need\n[11]: https://www.algolia.com/users/sign_up/hacker\n[12]: https://community.algolia.com/instantsearch.js/\n[13]: https://www.algolia.com/press/?section=brand-guidelines\n[14]: https://github.com/ayastreb/\n[15]: https://ayastreb.me/writing-a-jekyll-plugin/\n[16]: https://rubygems.org/gems/jekyll-algolia\n[17]: https://travis-ci.org/algolia/jekyll-algolia\n[18]: https://coveralls.io/github/algolia/jekyll-algolia?branch=master\n[20]: https://community.algolia.com/jekyll-algolia/getting-started.html\n[7]: http://unmaintained.tech/\n[19]: http://unmaintained.tech/badge.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgolia%2Fjekyll-algolia","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falgolia%2Fjekyll-algolia","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgolia%2Fjekyll-algolia/lists"}