https://github.com/benbarber/jekyll-instagram

A Jekyll plugin for displaying your recent Instagram photos
https://github.com/benbarber/jekyll-instagram

instagram instagram-api instagram-feed instagram-photos jekyll jekyll-instagram jekyll-plugin ruby

Last synced: about 6 hours ago
JSON representation

A Jekyll plugin for displaying your recent Instagram photos

• Host: GitHub
• URL: https://github.com/benbarber/jekyll-instagram
• Owner: benbarber
• Created: 2015-03-15T14:11:40.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-05-16T20:09:05.000Z (8 months ago)
• Last Synced: 2024-12-06T21:19:48.935Z (about 2 months ago)
• Topics: instagram, instagram-api, instagram-feed, instagram-photos, jekyll, jekyll-instagram, jekyll-plugin, ruby
• Language: Ruby
• Homepage: https://benbarber.github.io/jekyll-instagram/
• Size: 45.9 KB
• Stars: 29
• Watchers: 6
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Jekyll-Instagram Plugin

Jekyl-Instagram is a Jekyll plugin for displaying a feed of your recent Instagram photos.

**Live demo available at: https://benbarber.github.io/jekyll-instagram/**

### Installation and Setup

To install this plugin into your project you will need to copy `_plugins/jekyllgram.rb` into the `_plugins` directory

in your Jekyll project.

Then for the plugin to be able to communicate with Instagram you will need to register an application with the Instagram Basic Display API and then make your access token available as an environment variable on your dev/build machine named `JEKYLLGRAM_TOKEN`.

There is an easy step by step guide for getting your Instagram access token available [here](https://essential-addons.com/elementor/how-to-get-instagram-access-token/).

Your instagram account will need to be public for this to work correctly. To avoid making your main account public you can create a separate Instagram account just for your public feed and use that account.

### Working Example

There is a working example of a basic Jekyll site using this plugin that is available in the `example` directory of this repo.

### Displaying the results in your templates

To display the feed of your recent Instagram photos you will need to insert the liquid template tag below into one of the pages of your Jekyll site. You can replace the 6 below with the number of photos from Instagram that you wish to display.

```liquid

{% jekyllgram 6 %}

  

    

  

{% endjekyllgram %}

```

### Notes

If publishing to GitHub pages and you get a "jekyllgram - Liquid tag not found" build error you will need to use a custom GitHub actions workflow for deployment. The reason for this is that the default GitHub pages deployment doesnt allow for 3rd party Jekyll plugins unless they have been whitelisted by GitHub.

You can find more information [here](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#plugins) and view the full whitelist of plugins [here](https://pages.github.com/versions/).

You can find a working example of a custom GitHub actions workflow that publishes with this plugin at `.github/workflows/pages.yml`. This is used to publish the demo site which is available at https://benbarber.github.io/jekyll-instagram/

### Contributors

- [Zachary Wright](https://github.com/zachwright)

- [Jason](https://github.com/jschee)

### Changelog

- (v1.0.0) Initial release