171 lines
7.1 KiB
Markdown
171 lines
7.1 KiB
Markdown
# @astrojs/rss
|
||
|
||
## 2.1.0
|
||
|
||
### Minor Changes
|
||
|
||
- [#5851](https://github.com/withastro/astro/pull/5851) [`81dce94f2`](https://github.com/withastro/astro/commit/81dce94f2a6db598bd9e47fc2a4b9d713e58f286) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Update RSS config for readability and consistency with Astro 2.0.
|
||
|
||
#### Migration - `import.meta.glob()` handling
|
||
|
||
We have deprecated `items: import.meta.glob(...)` handling in favor of a separate `pagesGlobToRssItems()` helper. This simplifies our `items` configuration option to accept a single type, without losing existing functionality.
|
||
|
||
If you rely on our `import.meta.glob()` handling, we suggest adding the `pagesGlobToRssItems()` wrapper to your RSS config:
|
||
|
||
```diff
|
||
// src/pages/rss.xml.js
|
||
import rss, {
|
||
+ pagesGlobToRssItems
|
||
} from '@astrojs/rss';
|
||
|
||
export function get(context) {
|
||
return rss({
|
||
+ items: pagesGlobToRssItems(
|
||
import.meta.glob('./blog/*.{md,mdx}'),
|
||
+ ),
|
||
});
|
||
}
|
||
```
|
||
|
||
#### New `rssSchema` for content collections
|
||
|
||
`@astrojs/rss` now exposes an `rssSchema` for use with content collections. This ensures all RSS feed properties are present in your frontmatter:
|
||
|
||
```ts
|
||
import { defineCollection } from 'astro:content';
|
||
import { rssSchema } from '@astrojs/rss';
|
||
|
||
const blog = defineCollection({
|
||
schema: rssSchema,
|
||
});
|
||
|
||
export const collections = { blog };
|
||
```
|
||
|
||
## 2.1.0-beta.0
|
||
|
||
### Minor Changes
|
||
|
||
- [#5851](https://github.com/withastro/astro/pull/5851) [`81dce94f2`](https://github.com/withastro/astro/commit/81dce94f2a6db598bd9e47fc2a4b9d713e58f286) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Update RSS config for readability and consistency with Astro 2.0.
|
||
|
||
#### Migration - `import.meta.glob()` handling
|
||
|
||
We have deprecated `items: import.meta.glob(...)` handling in favor of a separate `pagesGlobToRssItems()` helper. This simplifies our `items` configuration option to accept a single type, without losing existing functionality.
|
||
|
||
If you rely on our `import.meta.glob()` handling, we suggest adding the `pagesGlobToRssItems()` wrapper to your RSS config:
|
||
|
||
```diff
|
||
// src/pages/rss.xml.js
|
||
import rss, {
|
||
+ pagesGlobToRssItems
|
||
} from '@astrojs/rss';
|
||
|
||
export function get(context) {
|
||
return rss({
|
||
+ items: pagesGlobToRssItems(
|
||
import.meta.glob('./blog/*.{md,mdx}'),
|
||
+ ),
|
||
});
|
||
}
|
||
```
|
||
|
||
#### New `rssSchema` for content collections
|
||
|
||
`@astrojs/rss` now exposes an `rssSchema` for use with content collections. This ensures all RSS feed properties are present in your frontmatter:
|
||
|
||
```ts
|
||
import { defineCollection } from 'astro:content';
|
||
import { rssSchema } from '@astrojs/rss';
|
||
|
||
const blog = defineCollection({
|
||
schema: rssSchema,
|
||
});
|
||
|
||
export const collections = { blog };
|
||
```
|
||
|
||
## 2.0.0
|
||
|
||
### Major Changes
|
||
|
||
- [#5612](https://github.com/withastro/astro/pull/5612) [`68c20be66`](https://github.com/withastro/astro/commit/68c20be66b197e6c525cd292823a3a728f238547) Thanks [@equt](https://github.com/equt)! - Filter out draft in RSS generation
|
||
|
||
## 1.2.1
|
||
|
||
### Patch Changes
|
||
|
||
- [#5600](https://github.com/withastro/astro/pull/5600) [`c4155daea`](https://github.com/withastro/astro/commit/c4155daeabe1b8191ad9ed1fa5893759f1fe5c4c) Thanks [@fflaten](https://github.com/fflaten)! - Fix missing type-attribute in xml-stylesheet
|
||
|
||
## 1.2.0
|
||
|
||
### Minor Changes
|
||
|
||
- [`c76e1c810`](https://github.com/withastro/astro/commit/c76e1c810228fb53cd9c34edc73747b0ab64dc28) Thanks [@mattstein](https://github.com/mattstein)! - Fixes a bug that prevented an item’s `customData` from being included.
|
||
|
||
## 1.1.0
|
||
|
||
### Minor Changes
|
||
|
||
- [#5366](https://github.com/withastro/astro/pull/5366) [`081e0a9d2`](https://github.com/withastro/astro/commit/081e0a9d2070b23d596b687ad52ed3a68bc3ac24) Thanks [@smithbm2316](https://github.com/smithbm2316)! - Added the ability for users to include the full content of their posts/items in each RSS feed entry
|
||
via the new `content` key on the `RSSFeedItem` model.
|
||
|
||
### Patch Changes
|
||
|
||
- [#5550](https://github.com/withastro/astro/pull/5550) [`fe0da0185`](https://github.com/withastro/astro/commit/fe0da0185a85762ac5ac5bf66ea91947af1c329d) Thanks [@andersk](https://github.com/andersk)! - Generate RSS feed with proper XML escaping
|
||
|
||
## 1.0.3
|
||
|
||
### Patch Changes
|
||
|
||
- [#5164](https://github.com/withastro/astro/pull/5164) [`4a8a346ca`](https://github.com/withastro/astro/commit/4a8a346ca9a6d6ed8def2fa32329c1db922893d2) Thanks [@MoustaphaDev](https://github.com/MoustaphaDev)! - Add support for markdown files with the following extensions:
|
||
- `.markdown`
|
||
- `.mdown`
|
||
- `.mkdn`
|
||
- `.mkd`
|
||
- `.mdwn`
|
||
|
||
## 1.0.2
|
||
|
||
### Patch Changes
|
||
|
||
- [#4842](https://github.com/withastro/astro/pull/4842) [`812658ad2`](https://github.com/withastro/astro/commit/812658ad2ab3732a99e35c4fd903e302e723db46) Thanks [@bluwy](https://github.com/bluwy)! - Add missing dependencies, support strict dependency installation (e.g. pnpm)
|
||
|
||
- [#4842](https://github.com/withastro/astro/pull/4842) [`812658ad2`](https://github.com/withastro/astro/commit/812658ad2ab3732a99e35c4fd903e302e723db46) Thanks [@bluwy](https://github.com/bluwy)! - Remove path-browserify dependency
|
||
|
||
## 1.0.1
|
||
|
||
### Patch Changes
|
||
|
||
- [#4701](https://github.com/withastro/astro/pull/4701) [`6e1d62fe2`](https://github.com/withastro/astro/commit/6e1d62fe222e45b763b2b60b377b07e431950d54) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Fix globs for homepage route
|
||
|
||
## 1.0.0
|
||
|
||
### Major Changes
|
||
|
||
- [`04ad44563`](https://github.com/withastro/astro/commit/04ad445632c67bdd60c1704e1e0dcbcaa27b9308) - > Astro v1.0 is out! Read the [official announcement post](https://astro.build/blog/astro-1/).
|
||
|
||
**No breaking changes**. This package is now officially stable and compatible with `astro@1.0.0`!
|
||
|
||
## 0.2.2
|
||
|
||
### Patch Changes
|
||
|
||
- [#3956](https://github.com/withastro/astro/pull/3956) [`57e529e4c`](https://github.com/withastro/astro/commit/57e529e4c13f3e7829311ac6f92682eb6333fd96) Thanks [@esafev](https://github.com/esafev)! - Throw the error when 'site' option is missing
|
||
|
||
## 0.2.1
|
||
|
||
### Patch Changes
|
||
|
||
- [#3913](https://github.com/withastro/astro/pull/3913) [`cd2dbfedb`](https://github.com/withastro/astro/commit/cd2dbfedb15969274df40b1c41b6680ea8885e8d) Thanks [@matthewp](https://github.com/matthewp)! - Adds error messages for missing required fields
|
||
|
||
## 0.2.0
|
||
|
||
### Minor Changes
|
||
|
||
- [#3301](https://github.com/withastro/astro/pull/3301) [`0efaf110`](https://github.com/withastro/astro/commit/0efaf110fceba149cd41cbaa0f37311e6887cdec) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Change the optional "canonicalUrl" argument to a required "site" argument. This fixes problems with import.meta.env.SITE. If you want to use your project's "site" field for your RSS feeds, set site: import.meta.env.SITE in the rss function options
|
||
|
||
## 0.1.1
|
||
|
||
### Patch Changes
|
||
|
||
- [`1032e450`](https://github.com/withastro/astro/commit/1032e450cc224e603e8e69ef1422de6dbf184dd2) Thanks [@FredKSchott](https://github.com/FredKSchott)! - Introduce new @astrojs/rss package for RSS feed generation! This also adds a new global env variable for your project's configured "site": import.meta.env.SITE. This is consumed by the RSS feed helper to generate the correct canonical URL.
|