Add an RSS feed
Это содержимое пока не доступно на вашем языке.
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.
Setting up @astrojs/rss
Section titled Setting up @astrojs/rssThe 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.
-
Install
@astrojs/rss
using your preferred package manager:Ensure you’ve configured a
site
in your project’sastro.config
. This will be used to generate links to your RSS articles. -
Create a file in
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 arefeed.xml
orrss.xml
.The example file below
src/pages/rss.xml.js
will create an RSS feed atsite/rss.xml
. -
Import the
rss()
helper from the@astrojs/rss
package into your.xml.js
file and export a function that returns it using the following parameters:
Generating items
Section titled Generating itemsThe 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/
.
Using content collections
Section titled Using content collectionsTo 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.
Using glob imports
Section titled Using glob imports
Добавлено в:
@astrojs/rss@2.1.0
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).
This function assumes, but does not verify, that all necessary feed properties are present in each document’s frontmatter. If you encounter errors, verify each page frontmatter manually.
In versions of @astrojs/rss
before v2.1.0, pass your glob result straight to items
without the pagesGlobToRssItems()
wrapper:
Including full post content
Section titled Including full post content
Добавлено в:
astro@1.6.14
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.
A package like sanitize-html
will make sure that your content is properly sanitized, escaped, and encoded. In the process, such a package might also remove some harmless elements and attributes, so make sure to verify the output and configure the package according to your needs.
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.
Adding a stylesheet
Section titled Adding a stylesheetStyle 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.
If you’d prefer not to create your own stylesheet, you may use a premade stylesheet such as the Pretty Feed v3 default stylesheet. Download the stylesheet from GitHub and save into your project’s public/
directory.
Next Steps
Section titled Next StepsAfter 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.