Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michaeldeboey/gatsby-plugin-instagram-embed
Gatsby plugin to add Instagram's embed script.
https://github.com/michaeldeboey/gatsby-plugin-instagram-embed
gatsby gatsby-plugin instagram
Last synced: 17 days ago
JSON representation
Gatsby plugin to add Instagram's embed script.
- Host: GitHub
- URL: https://github.com/michaeldeboey/gatsby-plugin-instagram-embed
- Owner: MichaelDeBoey
- License: mit
- Created: 2019-12-08T17:52:10.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-04-26T20:33:29.000Z (almost 2 years ago)
- Last Synced: 2025-01-12T00:25:29.823Z (22 days ago)
- Topics: gatsby, gatsby-plugin, instagram
- Language: JavaScript
- Homepage:
- Size: 108 KB
- Stars: 11
- Watchers: 4
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
gatsby-plugin-instagram-embed
Gatsby plugin to add Instagram's embed script.
---
[![Build Status][build-badge]][build]
[![version][version-badge]][package]
[![downloads][downloads-badge]][npmtrends]
[![MIT License][license-badge]][license]
[![All Contributors][all-contributors-badge]](#contributors-)
[![PRs Welcome][prs-badge]][prs]
[![Code of Conduct][coc-badge]][coc]
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Inspiration](#inspiration)
- [Issues](#issues)
- [🐛 Bugs](#-bugs)
- [💡 Feature Requests](#-feature-requests)
- [Contributors ✨](#contributors-)
- [LICENSE](#license)
## Installation
This module is distributed via [npm][npm] which is bundled with [node][node] and
should be installed as one of your project's `dependencies`:
```sh
npm install gatsby-plugin-instagram-embed
```
or
```sh
yarn add gatsby-plugin-instagram-embed
```
This library has a required `peerDependencies` listing for [`gatsby`][gatsby].
## Usage
```js
// In your gatsby-config.js
module.exports = {
// Find the 'plugins' array
plugins: [
`gatsby-plugin-instagram-embed`,
// Other plugins here...
],
};
```
Then, anywhere on your site, you can add an Instagram embed code like this one:
```html
View this post on Instagram
A tiki bar! Sugary drinks and friendly bartenders.
A post shared by
Jason Lengstorf
(@jlengstorf) on
```
> NOTE: When copying the embed code, just copy the blockquote section and not
> the `script`.
When the site is loaded, you’ll see the embedded Instagram post:
## Inspiration
Just like [`gatsby-plugin-twitter`][gatsby-plugin-twitter] is doing for the
[Twitter][twitter] embed script, this plugin adds the [Instagram][instagram]
embed script to your [`gatsby`][gatsby] site. It also adds resource hints to
help boost loading performance.
This whole plugin was extracted out of Jason Lengstorf's [personal
website][lengstorf.com-repo].
The intention is to make this available to be used independently.
## Issues
_Looking to contribute? Look for the [Good First Issue][good-first-issue]
label._
### 🐛 Bugs
Please file an issue for bugs, missing documentation, or unexpected behavior.
[**See Bugs**][bugs]
### 💡 Feature Requests
Please file an issue to suggest new features. Vote on feature requests by adding
a 👍. This helps maintainers prioritize what to work on.
[**See Feature Requests**][requests]
## Contributors ✨
Thanks goes to these wonderful people ([emoji key][emojis]):
Jason Lengstorf
💻 📖 🤔
Michaël De Boey
💻 📖 🚇 🔧
Caneco
🎨
This project follows the [all-contributors][all-contributors] specification.
Contributions of any kind welcome!
## LICENSE
MIT
[npm]: https://npmjs.com
[node]: https://nodejs.org
[build-badge]: https://img.shields.io/github/workflow/status/MichaelDeBoey/gatsby-plugin-instagram-embed/validate?logo=github&style=flat-square
[build]: https://github.com/MichaelDeBoey/gatsby-plugin-instagram-embed/actions?query=workflow%3Avalidate
[coverage-badge]: https://img.shields.io/codecov/c/github/MichaelDeBoey/gatsby-plugin-instagram-embed.svg?style=flat-square
[coverage]: https://codecov.io/github/MichaelDeBoey/gatsby-plugin-instagram-embed
[version-badge]: https://img.shields.io/npm/v/gatsby-plugin-instagram-embed.svg?style=flat-square
[package]: https://www.npmjs.com/package/gatsby-plugin-instagram-embed
[downloads-badge]: https://img.shields.io/npm/dm/gatsby-plugin-instagram-embed.svg?style=flat-square
[npmtrends]: http://www.npmtrends.com/gatsby-plugin-instagram-embed
[license-badge]: https://img.shields.io/npm/l/gatsby-plugin-instagram-embed.svg?style=flat-square
[license]: https://github.com/MichaelDeBoey/gatsby-plugin-instagram-embed/blob/main/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://github.com/MichaelDeBoey/gatsby-plugin-instagram-embed/blob/main/CODE_OF_CONDUCT.md
[emojis]: https://allcontributors.org/docs/en/emoji-key
[all-contributors]: https://github.com/all-contributors/all-contributors
[all-contributors-badge]: https://img.shields.io/github/all-contributors/MichaelDeBoey/gatsby-plugin-instagram-embed?color=orange&style=flat-square
[bugs]: https://github.com/MichaelDeBoey/gatsby-plugin-instagram-embed/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22%F0%9F%90%9B+Bug%22+sort%3Acreated-desc
[requests]: https://github.com/MichaelDeBoey/gatsby-plugin-instagram-embed/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement
[good-first-issue]: https://github.com/MichaelDeBoey/gatsby-plugin-instagram-embed/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3A%22good+first+issue%22
[gatsby]: https://github.com/gatsbyjs/gatsby
[gatsby-plugin-twitter]: https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-twitter
[instagram]: https://instagram.com
[lengstorf.com-repo]: https://github.com/jlengstorf/lengstorf.com
[twitter]: https://twitter.com