Skip to content

Commit 24449b4

Browse files
committed
docs(rss): add docs about filename
Add to the docs that the filename for the feed can be changed with config
1 parent 829d3ae commit 24449b4

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

plugins/rss/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ The rss feed is available at:
1010
- your-domain.de/feed.atom
1111
- your-domain.de/feed.xml
1212

13+
To change the filename of the feed, use the `filename` attribute in your rss.config.json file, as seen below. The default value is feed, but you can change it to whatever you'd like.
14+
1315
> **Breaking Change** introduced in Version 1.0.0 with changing the plugin type from `render` to `routeDiscoveryDone`. This has the major benefit of only generating the RSS Feed once per run instead of after each page render.
1416
1517
## 📦 Installation
@@ -53,9 +55,11 @@ Create a `rss.config.json` in your root with the following properties:
5355
"favicon": "https://you-domain.com/favicon.png",
5456
"copyright": "2020 your-domain.com",
5557
"generator": "Page description",
58+
"filename": "feed",
5659
"feedLinks": {
60+
"atom": "https://your-domain.com/feed.atom",
5761
"json": "https://your-domain.com/feed.json",
58-
"atom": "https://your-domain.com/feed.atom"
62+
"xml": "https://your-domain.com/feed.xml"
5963
},
6064
"outDir": "./dist/static",
6165
"categories": ["Categories", "of", "your", "choice"],

0 commit comments

Comments
 (0)