Astro supports fast, automatic RSS feed generation for blogs and other content websites. RSS feeds provide an easy way for users to subscribe to your content.
@astrojs/rss
The package @astrojs/rss provides helpers for generating RSS feeds using API endpoints. This unlocks both static builds and on-demand generation when using an SSR adapter.
@astrojs/rss using your preferred package manager:src/pages/ with a name of your choice and the extension .xml.js to be used as the output URL for your feed. Some common RSS feed URL names are feed.xml or rss.xml.The example file below src/pages/rss.xml.js will create an RSS feed at site/rss.xml.
rss() helper from the @astrojs/rss package into your .xml.js file and export a function that returns it using the following parameters:items
The items field accepts a list of RSS feed objects, each with a required link, title, and pubDate. Three optional values may also be included description (a short excerpt), content (the full content of your post), and a customData field for including any extra data, such as other frontmatter properties from your blog posts.
You can generate this array from a content collection schema or by using glob imports for blog posts located within src/pages/.
To create an RSS feed of pages managed in content collections, use the getCollection() function to retrieve the list of your items.
Optional: replace your existing blog collection schema to enforce the expected RSS properties.
To ensure that every blog entry produces a valid RSS feed item, you can optionally import and apply rssSchema instead of defining each individual property of your schema.
@astrojs/[email protected] To create an RSS feed from documents in src/pages/, use the pagesGlobToRssItems() helper. This accepts an import.meta.glob result and outputs an array of valid RSS feed items (see more about writing glob patterns for specifying which pages to include).
[email protected] The content key contains the full content of the post as HTML. This allows you to make your entire post content available to RSS feed readers.
When using content collections, render the post body using a standard Markdown parser like markdown-it and sanitize the result:
When using glob imports with Markdown, you may use the compiledContent() helper to retrieve the rendered HTML for sanitization. Note: this feature is not supported for MDX files.
Style your RSS feed for a more pleasant user experience when viewing the file in your browser.
Use the rss function’s stylesheet option to specify an absolute path to your stylesheet.
After visiting your feed in the browser at your-domain.com/rss.xml and confirming that you can see data for each of your posts, you can now promote your feed on your website. Adding the standard RSS icon to your site lets your readers know that they can subscribe to your posts in their own feed reader.
Learn how to share state across framework components with Nano Stores.
Add an RSS feed to your Astro site to let users subscribe to your content.
Learn how you can import YAML data by adding a Rollup plugin to your project.
Learn how to use JavaScript to send form submissions to an API Route
Learn how to build HTML forms and handle submissions in your frontmatter
Learn how to use Bun with your Astro site.
Learn how to call endpoints from the server in Astro.
Learn how to create an API route and fetch it from the client.
Learn how to build your Astro site using Docker.
Learn how to install a rehype plugin to add icons to external links in your Markdown files
Use dynamic routing and content collections to add internationalization support to your Astro site.
Build a remark plugin to add reading time to your Markdown or MDX files.
Learn how to share state across Astro components with Nano Stores.
© 2021 Fred K. Schott
Licensed under the MIT License.
https://docs.astro.build/en/guides/rss/