feat(docs): adding an RSS Feed #11941
Conversation
Co-Authored-By: marcysutton <[email protected]>
Co-Authored-By: marcysutton <[email protected]>
|
The plugin should be fixed so "fields.slug" isn't required. You should be able to specify that directly. Lots of people will have the URL elsewhere. |
|
Just as an idea: What about i18n and RSS feeds? |
|
@LekoArts I love the idea! Since there isn't much on i18n currently, I think that addition could come later after this doc is merged. |
|
Ok, this PR is ready! I had to fix some permalinks in my own feed to get a full understanding of what was going on. In short, I have custom For the post, I kept the customization details simple based on your feedback and added an "ask us for help!" callout in case anyone gets stuck. Given Wordpress generates RSS automatically, we should make this as easy to figure out as possible. I'll file an issue to look into i18n for RSS. Thanks for the suggestions! |
docs/docs/adding-an-rss-feed.md
Outdated
|
|
||
| To customize the default feed schema (a.k.a. structure) output by the plugin to work with your website's content, you can start with the following code: | ||
|
|
||
| ```json:title=gatsby.config.js |
There was a problem hiding this comment.
This is js!
Would generally recommend doing something like:
```js:title=gatsby-config.js
module.exports = {
plugins: [
// your code block
]
}
```just so we can show it as real-world as possible!
|
|
||
| To see your feed in action, run `gatsby build && gatsby serve` and you can then inspect the content and URLs in your RSS file at `http://localhost:9000/rss.xml`. | ||
|
|
||
| > NOTE: if your blog has custom permalinks, such as links with or without dates in them, you may need to [customize `gatsby-node.js`](https://github.com/gatsbyjs/gatsby-starter-blog/blob/master/gatsby-node.js#L57) to output the correct URLs in your RSS feed. [Get in touch with us](/contributing/how-to-contribute/) if you need any help! |
There was a problem hiding this comment.
Seriously, when I was learning to build websites I would have loved this. I felt bad always pestering my one friend who knew how everything worked...having a whole community available would have been amazing.
| title | ||
| description | ||
| siteUrl | ||
| site_url: siteUrl |
There was a problem hiding this comment.
any explanation why this additional site_url is needed?
Description
When I set up an RSS feed for my website, I found some critical information was missing from the
gatsby-plugin-feedREADME. I also didn't see a doc for creating an RSS feed, so I added one. That's what this PR does, in addition to some title case updates todoc-links.ymlwhile I was in there.