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

@matiasfha/gatsby-plugin-frontmatter-featured-image

v1.0.1

Published

Read frontmatter featured image and create a local image

Downloads

7

Readme

What this plugin do?

This plugin will retrieve an image url defined as part of the frontmatter of a MDX or MarkdownRemark file and create a file node to be used with gatsby-plugin-image or gatsby-image

How to install

Just install as any other gatsby plugin!

$ npm install @matiasfha/gatsby-plugin-frontmatter-featured-image

or

$ yarn add gatsby-plugin-frontmatter-featured-image

then add this to your gatsby-config.js file as a plugin

{
  resolve: `@matiasfha/gatsby-plugin-frontmatter-featured-image,
  options: {
    image: 'featuredImage'
    }
}

How to configure the plugin

This plugin have only one configuration option, that is the image property. This property is used to let the plugin know what frontmatter attribute is used to store the image url

How to query?

This plugin will create a new "entry" when you are querying for your mdx data that will be named the same as the image property of the configuration, in this case featuredImage.

query MyQuery {
  allMdx {
    nodes {
      featuredImage {
        childImageSharp {
          gatsbyImageData
        }
      }
    }
  }
}

How it works?

It works by using the createResolvers gatsby api to create a new resolver on Mdx or MarkdownRemark files. On each node will create a new file node by using createRemoteFileNode from gatsby-source-filesystem this enable you to directly query and get gatsbyImageData.

Rationale

This was created out of the need of create nodes that are queryable to be used with gatsby-plugin-image when using the filesystem route api. With filesystem route api you have access to the body of the mdx file and also the frontmatter, but if you use an external image in frontmatter you cannot used as a dynamic image with gatsby-plugin-image This plugin solve that by created the required nodes.