{"id":16552394,"url":"https://github.com/dieghernan/algolia-jekyll-action","last_synced_at":"2025-10-28T19:30:18.565Z","repository":{"id":65159532,"uuid":"331471775","full_name":"dieghernan/algolia-jekyll-action","owner":"dieghernan","description":"Runs jekyll-algolia plugin for GitHub Pages","archived":false,"fork":false,"pushed_at":"2025-01-20T10:16:57.000Z","size":18,"stargazers_count":7,"open_issues_count":1,"forks_count":7,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-01T17:35:10.305Z","etag":null,"topics":["algolia","algolia-instantsearch","algolia-search","github-actions","github-pages","github-pages-website","jekyll","ruby","search"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/algolia-jekyll-action","language":null,"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/dieghernan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":"dieghernan","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2021-01-21T00:41:43.000Z","updated_at":"2025-01-20T10:16:59.000Z","dependencies_parsed_at":"2024-02-08T07:42:13.457Z","dependency_job_id":null,"html_url":"https://github.com/dieghernan/algolia-jekyll-action","commit_stats":{"total_commits":17,"total_committers":3,"mean_commits":5.666666666666667,"dds":0.5294117647058824,"last_synced_commit":"3987e63d8d82eb5ad204b9a2fcdc2a666a4333ca"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dieghernan%2Falgolia-jekyll-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dieghernan%2Falgolia-jekyll-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dieghernan%2Falgolia-jekyll-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dieghernan%2Falgolia-jekyll-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dieghernan","download_url":"https://codeload.github.com/dieghernan/algolia-jekyll-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238700696,"owners_count":19515976,"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":["algolia","algolia-instantsearch","algolia-search","github-actions","github-pages","github-pages-website","jekyll","ruby","search"],"created_at":"2024-10-11T19:44:42.506Z","updated_at":"2025-10-28T19:30:18.135Z","avatar_url":"https://github.com/dieghernan.png","language":null,"funding_links":["https://ko-fi.com/dieghernan"],"categories":[],"sub_categories":[],"readme":"# algolia-jekyll-action\n\n![latest-version](https://img.shields.io/github/v/release/dieghernan/algolia-jekyll-action)\n![gh-pages](https://img.shields.io/badge/gh—pages-ready-green)\n![jekyll](https://img.shields.io/badge/jekyll-%3E%3D%203.6.0-blue)\n![ruby](https://img.shields.io/badge/ruby-%3E%3D%202.3.0-blue)\n\nThis is a wrapper of the [jekyll-algolia](https://community.algolia.com/jekyll-algolia/) plugin.\n\n### 🎉 GitHub Pages ready!\n\n\nThis action pushes all your content in an Algolia index.\n\n## Repo setup \n\nFull reference on the [`jekyll-algolia` documentation](https://community.algolia.com/jekyll-algolia/getting-started.html).\n\n### A. Install `jekyll-algolia`\n\n1. On your [Algolia](https://www.algolia.com/) account (free Community plan available), get your credentials from your dashboard.\n\n2. On your `_config.yml`, write:\n\n  ```yaml\n  \n  algolia:\n     application_id: YOUR_APPLICATION_ID\n     index_name: YOUR_INDEX_NAME # You can replace that with whatever name you want\n     search_only_api_key: YOUR_SEARCH_ONLY_API_KEY\n     \n  ```\n  \n3. Add `jekyll-algolia` to your `Gemfile`, as part of the `:jekyll-plugins` group.\n\n  ```ruby\n  source 'https://rubygems.org'\n  gem 'jekyll', '~\u003e 3.6'\n  \n  group :jekyll_plugins do\n    gem 'jekyll-algolia'\n  end\n  ```\n\n4. **Important**: On your GitHub repo, go to *Settings \u003e Secrets* and set a new secret:\n\n  | Name  | Value |\n  | --- | --- |\n  | `ALGOLIA_API_KEY` | `YOUR_ADMIN_API_KEY` |\n\n### B. Create a GitHub Action\n\nCreate a workflow file (e.g. `algolia-search.yml`) in `your-repo/.github/workflows/` directory, similar to:\n\n``` yaml\non:\n  push:\n    branches:\n      - master\n      - main\n\nname: algolia-search\njobs:\n  algolia-search:\n    runs-on: ubuntu-latest\n    env:\n      JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n    steps:\n      - uses: actions/checkout@v3\n      - name: Algolia Jekyll Action\n        uses: dieghernan/algolia-jekyll-action@main\n        with:\n          APIKEY: '${{ secrets.ALGOLIA_API_KEY }}'\n\n```\n\nThis action would run on every commit on the `main/master`. For more trigger events see [this link](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#configuring-workflow-events).\n\n## Inputs available\n\n-   `APIKEY`: Required. It is better to use GitHub Secrets (see above) instead the actual value on the action, for security reasons.\n-   `ruby-version`: Version of Ruby to use on build. Default is `'2.6'`.\n-   `cache-version`: default `1`. If you need to invalidate the existing cache pass any other number and a new cache will be used.\n-   `jekyll_src`: default `\"\"`. Jekyll website source directory. Use it if the source of your site is in a subfolder (e.g `docs`, etc.).\n\n\n## Disclaimer\n\nThis software is in no way officially related to or endorsed by Algolia.\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdieghernan%2Falgolia-jekyll-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdieghernan%2Falgolia-jekyll-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdieghernan%2Falgolia-jekyll-action/lists"}