docs: add rss guide #43
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
sarah11918
commented
May 11, 2024
| site: 'https://www.example.com' | ||
| starlight({ | ||
| social: { | ||
| rss: 'https://www.example.com/blog/rss.xml', |
There was a problem hiding this comment.
Note: I don't know whether this URL needs to be absolute or not!
|
|
||
| This will create a `.xml` file for feed readers and add the standard RSS icon to your website's header. | ||
|
|
||
| Learn more about RSS feeds in Astro, including how to [enable RSS feed auto-discovery](https://docs.astro.build/en/guides/rss/#enabling-rss-feed-auto-discovery) in the official Astro documentation. |
There was a problem hiding this comment.
I chose to link back to Astro here because this page also has more generic RSS info at external links.
HiDeoo
approved these changes
May 11, 2024
There was a problem hiding this comment.
Thanks a lot, I really appreciate the changes you made. 🙌
I hope you won't mind, I made a few extra changes based on your feedback and the Discord discussion:
- I moved your entire new section to a dedicated RSS guide (I always find that my plugins docs sidebar are kind of empty so I thought it was a good opportunity to add a new page)
- I added a new intro section describing exactly what is happening behind the scenes as it was not obvious at all (e.g. RSS auto-discovery is automatically configured by the plugin)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe the pull request
This adds a section at the bottom of the main docs page for setting up the RSS feed.
Why
Although RSS will be enabled with only the
siteproperty configured, setting this up fully on the site the way people would expect isn't obvious without some guidance:Explicitly telling people what the feed URL is: it's not clear at which address the feed will exist. (
feed.xml?rss.xml?) And, it's also not obvious that it exists at/blog/.Adding the RSS icon in the header: most people will want the standard icon to show up, and this requires following Starlight's instructions to do so.
How
This is a description of the steps I took to fully add RSS to my site, in the way a blog owner would expect.
Screenshots