{"id":13612172,"url":"https://github.com/ayastreb/jekyll-maps","last_synced_at":"2025-04-05T09:10:07.601Z","repository":{"id":56863384,"uuid":"63414299","full_name":"ayastreb/jekyll-maps","owner":"ayastreb","description":":earth_americas: Embed maps with filterable locations in Jekyll","archived":false,"fork":false,"pushed_at":"2022-11-29T04:55:55.000Z","size":266,"stargazers_count":134,"open_issues_count":15,"forks_count":41,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-04-24T18:13:49.697Z","etag":null,"topics":["google-maps","jekyll-plugin","marker-clustering","ruby"],"latest_commit_sha":null,"homepage":"https://ayastreb.me/jekyll-maps/","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/ayastreb.png","metadata":{"files":{"readme":"README.md","changelog":"History.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-15T10:37:03.000Z","updated_at":"2024-03-12T12:40:48.000Z","dependencies_parsed_at":"2022-09-11T01:11:42.474Z","dependency_job_id":null,"html_url":"https://github.com/ayastreb/jekyll-maps","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayastreb%2Fjekyll-maps","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayastreb%2Fjekyll-maps/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayastreb%2Fjekyll-maps/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayastreb%2Fjekyll-maps/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ayastreb","download_url":"https://codeload.github.com/ayastreb/jekyll-maps/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247312085,"owners_count":20918344,"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":["google-maps","jekyll-plugin","marker-clustering","ruby"],"created_at":"2024-08-01T20:00:23.918Z","updated_at":"2025-04-05T09:10:06.943Z","avatar_url":"https://github.com/ayastreb.png","language":"Ruby","funding_links":[],"categories":["Geocoding \u0026 Maps","Ruby","Resources"],"sub_categories":["Plugins"],"readme":"# Jekyll Maps\n\n[![Gem Version](https://badge.fury.io/rb/jekyll-maps.svg)](https://badge.fury.io/rb/jekyll-maps)\n[![Build Status](https://travis-ci.org/ayastreb/jekyll-maps.svg?branch=master)](https://travis-ci.org/ayastreb/jekyll-maps)\n[![Code Climate](https://codeclimate.com/github/ayastreb/jekyll-maps/badges/gpa.svg)](https://codeclimate.com/github/ayastreb/jekyll-maps)\n[![Test Coverage](https://codeclimate.com/github/ayastreb/jekyll-maps/badges/coverage.svg)](https://codeclimate.com/github/ayastreb/jekyll-maps/coverage)\n[![Dependency Status](https://gemnasium.com/badges/github.com/ayastreb/jekyll-maps.svg)](https://gemnasium.com/github.com/ayastreb/jekyll-maps)\n\nJekyll Maps is a plugin that allows you to easily create different maps on your Jekyll site pages.\nIt allows you to select which points to display on the map with different filters.\n\nGoogleMaps Marker Clusterer can be used if you have many points within close proximity.\n\n## Installation\n\n1. Add the following to your site's `Gemfile`:\n\n\n```ruby\ngem 'jekyll-maps'\n```\n\n2. Add the following to your site's `_config.yml`:\n\n\n```yml\nplugins:\n  - jekyll-maps\n```\n\n## Usage\n\n### Configure Google API Key\n\nTo be able to use Google Maps you need to obtain\n[API Key](https://developers.google.com/maps/documentation/javascript/get-api-key).\n\nOnce you have your API Key you need to add it to Jekyll's `_config.yml`:\n\n```yml\nmaps:\n  google:\n    api_key: \u003cYOUR_KEY\u003e\n```\n\n### Data Source\n\nFirst, add location information to your posts YAML front-matter:\n\n```yml\nlocation:\n  latitude: 51.5285582\n  longitude: -0.2416807\n```\n\nYou can specify multiple locations per post:\n\n```yml\nlocation:\n  - latitude: 51.5285582\n    longitude: -0.2416807\n  - latitude: 52.5285582\n    longitude: -2.2416807\n  - title: custom marker title\n    image: custom marker image\n    url: custom marker url\n    latitude: 51.5285582\n    longitude: -0.2416807\n```\n\nAlternatively, you can add location info to your custom collection's documents or even in data\nfiles:\n\n```yml\n- title: Paris\n  url: http://google.fr\n  location:\n    latitude: 48.8587741\n    longitude: 2.2074741\n\n- title: Madrid\n  url: http://google.es\n  location:\n    latitude: 40.4378698\n    longitude: -3.8196204\n```\n\nBy default this plugin will display location from the page it's placed on:\n\n```\n{% google_map %}\n```\n\nBut you can use src attribute to load locations from other places, like posts, collections or data\nfiles!\n\nFor example, this map will show locations from all posts from 2016:\n\n```\n{% google_map src=\"_posts/2016\" %}\n```\n\nThis map will show locations from a collection called 'my_collection':\n\n```\n{% google_map src=\"_collections/my_collection\" %}\n```\n\nThis map will show locations from all data files located in 'my_points' sub-folder:\n\n```\n{% google_map src=\"_data/my_points\" %}\n```\n\nYou can configure map's dimensions and assign custom CSS class to the element:\n\n```\n{% google_map width=\"100%\" height=\"400\" class=\"my-map\" %}\n```\n\nYou can also just set marker coordinates directly in tag attributes:\n\n```\n{% google_map latitude=\"48.8587741\" longitude=\"2.2074741\" marker_title=\"My Location\" marker_img=\"/img.jpg\" marker_url=\"/my-location.html\" %}\n```\n\nThis will create a map with single marker in given location. `marker_title`, `marker_img` and\n`marker_url` attributes are optional and current page's data will be used by default.\n\n### Filters\n\nYou can also filter which locations to display on the map!\u003cbr/\u003e For instance, following tag will\nonly display locations from documents which have `lang: en` in their front-matter data.\n\n```\n{% google_map src=\"_posts\" lang=\"en\" %}\n```\n\n### Marker Cluster\n\nBy default [Marker Clusterer](https://github.com/googlemaps/js-marker-clusterer) is enabled. If you\nhave many markers on the map, it will group them and show icon with the count of markers in each\ncluster -\n[see example](https://googlemaps.github.io/js-marker-clusterer/examples/advanced_example.html).\n\nIf you don't want to use marker cluster, you can disable it globally in `_config.yml`:\n\n```yml\nmaps:\n  google:\n    marker_cluster:\n      enabled: false\n```\n\nOr you can disable it per single map tag:\n\n```\n{% google_map no_cluster %}\n```\n\nIf you have any questions or proposals - open up an\n[issue](https://github.com/ayastreb/jekyll-maps/issues/new)!\n\n## Examples\n\nWant to see it in action? Check out [Demo Page](https://ayastreb.me/jekyll-maps/#examples)!\n\n## Contributing\n\n1. Fork it (https://github.com/ayastreb/jekyll-maps/fork)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## License\n\n[MIT](https://github.com/ayastreb/jekyll-maps/blob/master/LICENSE). Feel free to use, copy or\ndistribute it.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fayastreb%2Fjekyll-maps","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fayastreb%2Fjekyll-maps","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fayastreb%2Fjekyll-maps/lists"}