{"id":17495719,"url":"https://github.com/brint/jekyll-google_cse","last_synced_at":"2025-03-20T04:30:47.141Z","repository":{"id":48701652,"uuid":"59372254","full_name":"brint/jekyll-google_cse","owner":"brint","description":"Adds Google Custom Search engine to Jekyll","archived":false,"fork":false,"pushed_at":"2024-01-14T03:33:21.000Z","size":24,"stargazers_count":6,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-21T04:04:29.612Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/jekyll-google_cse","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/brint.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":"2016-05-21T17:14:40.000Z","updated_at":"2023-01-24T00:53:44.000Z","dependencies_parsed_at":"2024-10-27T21:45:39.719Z","dependency_job_id":"420e17bb-eb35-420f-9513-8229fe8994d5","html_url":"https://github.com/brint/jekyll-google_cse","commit_stats":{"total_commits":13,"total_committers":2,"mean_commits":6.5,"dds":"0.46153846153846156","last_synced_commit":"e078aebd5a226d8e2ed2919da7fec406add88d77"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brint%2Fjekyll-google_cse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brint%2Fjekyll-google_cse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brint%2Fjekyll-google_cse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brint%2Fjekyll-google_cse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brint","download_url":"https://codeload.github.com/brint/jekyll-google_cse/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244047647,"owners_count":20389206,"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-10-19T14:24:43.345Z","updated_at":"2025-03-20T04:30:45.822Z","avatar_url":"https://github.com/brint.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jekyll::GoogleCse\n[![Gem Version](https://img.shields.io/gem/v/jekyll-google_cse.svg)][ruby-gems]\n[![Build Status](https://travis-ci.org/brint/jekyll-google_cse.svg?branch=master)][travis]\n[![Code Climate](https://codeclimate.com/github/brint/jekyll-google_cse/badges/gpa.svg)][codeclimate]\n[![Test Coverage](https://codeclimate.com/github/brint/jekyll-google_cse/badges/coverage.svg)][coverage]\n[![Dependency Status](https://gemnasium.com/badges/github.com/brint/jekyll-google_cse.svg)][gemnasium]\n[![Security](https://hakiri.io/github/brint/jekyll-google_cse/master.svg)][hakiri]\n\n[ruby-gems]: https://rubygems.org/gems/jekyll-google_cse\n[travis]: https://travis-ci.org/brint/jekyll-google_cse\n[codeclimate]: https://codeclimate.com/github/brint/jekyll-google_cse\n[coverage]: https://codeclimate.com/github/brint/jekyll-google_cse/coverage\n[gemnasium]: https://gemnasium.com/github.com/brint/jekyll-google_cse\n[hakiri]: https://hakiri.io/github/brint/jekyll-google_cse/\n\n\nAdd [Google Custom Search Engine](https://cse.google.com/) to your Jekyll site.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'jekyll-google_cse'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install jekyll-google_cse\n\n## Usage\n\nAdd the necessary configuration to to `_config.yml`. Start by adding `jekyll-google_cse` to the list of gems for Jekyll to install:\n\n```yaml\ngems:\n  - jekyll-google_cse\n```\n\nNext configure your site to use your \"Search engine ID\", which will be on the \"Basics\" page when you are configuring your custom search engine. In your Jekyll `_config.yml`, add your search engine ID:\n\n```yaml\ngoogle_cse_id: \"000000000000000000000:fffffffffff\" # Use your search engine ID\n```\n\nThen add the following tag after the following line where you'd like the Google Custom Search Engine to be show:\n\n```liquid\n{% google_cse %}\n```\n\n If you're not sure where to place the search engine, I'd recommend putting it in `_layouts/default.html` inside the `page-content` block:\n\n```html\n\u003cdiv class=\"page-content\"\u003e\n  \u003cdiv class=\"wrapper\"\u003e\n    {% google_cse %}\n    {{ content }}\n  \u003c/div\u003e\n\u003c/div\u003e\n```\n\nDoing this will make the search engine appear at the top of every page.\n\nIf you have multiple environments, you may only want to have the Google Custom Search Engine appear in a specific environment. Here's an example of how to only use the Google Custom Search Engine in your `production` environment:\n\n```liquid\n{% if jekyll.environment == \"production\" %}{% google_cse %}{% endif %}\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 tags, 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/brint/jekyll-google_cse. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrint%2Fjekyll-google_cse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrint%2Fjekyll-google_cse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrint%2Fjekyll-google_cse/lists"}