fix(gatsby-plugin-feed): update documentation and expose custom_names…

…paces
gatsbyjs · Apr 12, 2023 · 91a45de · 91a45de
1 parent 85d2aed
commit 91a45de
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/packages/gatsby-plugin-feed/README.md b/packages/gatsby-plugin-feed/README.md
@@ -48,8 +48,8 @@ module.exports = {
                   nodes {
                     excerpt
                     html
-                    fields { 
-                      slug 
+                    fields {
+                      slug
                     }
                     frontmatter {
                       title
@@ -68,13 +68,18 @@ module.exports = {
             match: "^/blog/",
             // optional configuration to specify external rss feed, such as feedburner
             link: "https://feeds.feedburner.com/gatsby/blog",
+            // optional to specify custom namespace for node elements
+            custom_namespaces: {
+              media: 'http://search.yahoo.com/mrss/',
+            }
           },
         ],
       },
     },
   ],
 }
 ```
+The GraphQL `query` property located directly under `options` queries `siteMetadata` from `gatsby-config` which contains the `title`, `description`, and `site_url` properties that are used to populate [the `feedOptions` of the `rss` package](https://www.npmjs.com/package/rss#feedoptions).
 
 Each feed must include `output`, `query`, `title`, and `serialize`. You'll need to write the `serialize` function in order to fit your use case.
 

diff --git a/packages/gatsby-plugin-feed/src/plugin-options.js b/packages/gatsby-plugin-feed/src/plugin-options.js
@@ -9,6 +9,7 @@ const feed = ({ Joi }) =>
     serialize: Joi.func().required(),
     match: Joi.string(),
     link: Joi.string(),
+    custom_namespaces: Joi.object(),
   })
     .unknown(true)
     .external(({ query }) => {