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-plugin-podcast-feed-mdx

v0.1.0-beta.0

Published

Gatsby plugin to generate a podcast rss feed using mdx for episodes.

Downloads

8

Readme

gatsby-plugin-podcast-feed-mdx

This Gatsby plugin will generate a podcast rss feed that is published on your site.

It can be used to submit to podcast directories such as Apple Podcasts, Stitcher, Spotify, Google Podcasts, TuneIn Radio, Pandora, Listen Notes, iHeartRadio, AnyPod etc...

The section in the feed that describes the podcast itself is based on values configured in your gatsby-config file.

Descriptions for each episode are generated based on values configured within individual mdx files, i.e. one for each episode.

The feed will be written out to a site root-relative path specified in gatsby-config.

Pre-requisites

This plugin assumes the following:

  1. You are using gatsby-plugin-mdx in your site to generate pages from markdown files.
  2. You will have one markdown file per podcast episode.

See here for background:

  • https://www.gatsbyjs.org/docs/mdx/
  • https://mdxjs.com/getting-started/gatsby

Installation

npm install --save gatsby-plugin-podcast-feed-mdx

or

yarn add gatsby-plugin-podcast-feed-mdx

Usage

Your gatsby-config.js File

module.exports = {
  plugins: [
    {
      resolve: `gatsby-plugin-podcast-feed-mdx`,
      options: {
        title: `Podcast Title`,
        subtitle: `A pithy tagline`,
        description: `Podcast description`,
        summary: `Podcast summary`,
        podcastType: `episodic`,
        siteUrl: `https://podcast.com`,
        imageUrl: `https://podcast.com/podcast-image/png`,
        feedUrl: `https://podcast.com/pocast-rss-feed.xml`,
        language: `en-au`,
        copyright: `Copyright © 2020 Some Owner`,
        authorName: `The Author`,
        ownerName: `The Owner`,
        ownerEmail: `[email protected]`,
        managingEditor: `[email protected]`,
        webMaster: `[email protected]`,
        explicit: `no`,
        publicationDate: `Jan 25, 2020 10:00:00 GMT`,
        category1: `Arts`,
        subCategory1: `Books`,
        category2: `Education`,
        subCategory2: `Courses`,
        category3: `Business`,
        subCategory3: `Marketing`,
        timeToLive: `60`,
        outputPath: `/podcast-rss-feed.xml`
      },
    },
  ],
}

Your Podcast Episode Mdx File(s)

In each .mdx file you have the following...

---
type: podcast-episode
status: published
slug: /your-website-path/to-this-episode
guid: c30fddca-79fb-48b1-8ad5-69591149df8c
title: Hello, podcast!
subtitle: The first ever episode.
publicationDate: 2019-01-29
author: Podcast host
season: 1
episodeNumber: 1
episodeType: trailer
excerpt: Here is the excerpt for the first podcast episode.
url: https://podcast.com/podcast/episode.mp3
size: 206820339
duration: 3414
explicit: false
categories:
  - Category 1
  - Category 2
---

Your main content here.

Why hello there, I'm a podcast episode!

Output

The main output of this plugin is an rss file for a podcast.

The structure of the generated rss file has been designed to support Apple Podcasts requirements and Google Feed requirements

The rss file is generated when you run gatsby build. (note: the rss file is not generated when you run gatsby develop)

Related Info

For information about the general rss feed specification, see the following:

For information about podcast-specific rss feed specifications, see the following: