HiDeoo / starlight-blog

Starlight plugin to add a blog to your documentation
https://starlight-blog-docs.vercel.app
MIT License
159 stars 21 forks source link

docs: add rss guide #43

Closed sarah11918 closed 6 months ago

sarah11918 commented 6 months ago

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 site property configured, setting this up fully on the site the way people would expect isn't obvious without some guidance:

  1. 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/.

  2. 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

image

image

vercel[bot] commented 6 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
starlight-blog-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 11, 2024 7:53pm