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

@jpfulton/gatsby-plugin-feed-mdx

v0.0.4

Published

Creates an RSS feed for your Gatsby MDX site.

Downloads

7

Readme

gatsby-plugin-feed-mdx

ci npm version

This is a fork of gatsby-plugin-feed-mdx which is a fork of gatsby-plugin-feed. Create an RSS feed (or multiple feeds) for your Gatsby site with MDX.

It was forked to update package references to that latest Gatsby.

Install

yarn install gatsby-plugin-feed-mdx

How to Use

// In your gatsby-config.js
module.exports = {
  plugins: [
    {
      {
      resolve: `@jpfulton/gatsby-plugin-feed-mdx`,
      options: {
        query: `
          {
            site {
              siteMetadata {
                title
                description
                siteUrl
                site_url: siteUrl
              }
            }
          }
        `,
        feeds: [
          {
            serialize: ({ query: { site, allMdx } }) => {
              return allMdx.edges.map((edge) => {
                return Object.assign({}, edge.node.frontmatter, {
                  description:
                    edge.node.frontmatter.description ?? edge.node.excerpt,
                  date: edge.node.frontmatter.date,
                  url:
                    site.siteMetadata.siteUrl + "/blog" + edge.node.fields.slug,
                  guid:
                    site.siteMetadata.siteUrl + "/blog" + edge.node.fields.slug,
                  custom_elements: [{ "content:encoded": edge.node.body }],
                });
              });
            },
            query: `
              {
                allMdx(
                  sort: { frontmatter: {date: DESC} },
                ) {
                  edges {
                    node {
                      excerpt
                      body
                      fields { slug }
                      frontmatter {
                        title
                        date
                        description
                      }
                    }
                  }
                }
              }
            `,
            output: "/rss.xml",
            title: "jpatrickfulton.dev",
            // optional configuration to insert feed reference in pages:
            // if `string` is used, it will be used to create RegExp and then test if pathname of
            // current page satisfied this regular expression;
            // if not provided or `undefined`, all pages will have feed reference inserted
            match: "^/blog/",
          },
        ],
      },
    },
  ],
};

Each feed must include output, query, and title. Additionally, it is strongly recommended to pass a custom serialize function, otherwise an internal serialize function will be used which may not exactly match your particular use case.

match is an optional configuration, indicating which pages will have feed reference included. The accepted types of match are string or undefined. By default, when match is not configured, all pages will have feed reference inserted. If string is provided, it will be used to build a RegExp and then to test whether pathname of current page satisfied this regular expression. Only pages that satisfied this rule will have feed reference included.

All additional options are passed through to the rss utility. For more info on those additional options, explore the itemOptions section of the rss package.

Check out an example of how you could implement to your own site, with a custom serialize function, and additional functionality.

NOTE: This plugin only generates the xml file(s) when run in production mode! To test your feed, run: gatsby build && gatsby serve.