npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gatsby-remark-giphy

v2.0.0

Published

Embed giphy search results with ![](giphy:search_term))

Downloads

46

Readme

gatsby-remark-giphy

All Contributors

Gatsby Remark plugin to embed gifs with ![](giphy:yay_a_gif)

The problem

Looking for gifs disrupts your writing flow. Use ![](giphy:search_term) and let gatsby-remark-giphy do the hard work for you.

For example, this line anywhere in your markdown:

![](giphy:yay_a_gif)

Creates a gif like this:

First search result from Giphy's API is used. This might not return the same image every time you run Gatsby build.

Installation

npm install gatsby-remark-giphy

or

yarn add gatsby-remark-giphy

gatsby-remark-giphy is meant to be used as a plugin for gatsby-transformer-remark or gatsby-plugin-mdx.

Usage

// In your gatsby-config.js

module.exports = {
    // Find the 'plugins' array
    plugins: [
        {
            resolve: `gatsby-transformer-remark`,
            options: {
                plugins: [
                    {
                        resolve: `gatsby-remark-giphy`,
                        options: {
                            giphyApiKey: `<your-api-key>`,
                        },
                    },

                    // Other plugins here...
                ],
            },
        },
    ],
};
// In your gatsby-config.js

module.exports = {
    // Find the 'plugins' array
    plugins: [
        {
            resolve: `gatsby-plugin-mdx`,
            options: {
                gatsbyRemarkPlugins: [
                    {
                        resolve: `gatsby-remark-giphy`,
                        options: {
                            giphyApiKey: `<your-api-key>`,
                        },
                    },

                    // Other plugins here...
                ],
            },
        },
    ],
};

Options

You can configure how gatsby-remark-giphy works with these helpful options:

  • giphyApiKey: required - your Giphy API Key. Create a Giphy developers account, request an API key, and you're ready to go. You should consider using this via an ENV variable of some sort instead of directly in your gatsby-config
  • useVideo: optional - false by default. Whether to embed gifs as an autoplaying HTML5 video
  • useIframe: optional - false by default. Whether to embed gifs as Giphy's iframe embed.
  • embedWidth: options - 100% by default. Gif embed width for video and iframe options.

gatsby-remark-giphy uses plain gif-as-an-image embeds by default.

Getting the best performance

Video and iframe embeds use native lazy loading. Here's a performance comparison using an in-browser Lighthouse audit with different options.

Measured using ServerlessReact.Dev homepage to measure deployed to Zeit. There's a bunch of stuff on the page slowing it down. Configs for the 8 gifs embedded via ![](giphy:) are the only variable changing between tests.

Basic gif embed

Video embed

useVideo: true

Iframe embed

useIframe: true

Contributors ✨

LICENSE

MIT