Skip to content

Commit 0945623

Browse files
committed
docs: update docs
1 parent 4498e12 commit 0945623

2 files changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Scully Plugins
22

3-
This repository has the following available plugins for [scully](https://github.com/scullyio/scully).
3+
This repository has the following available plugins for [Scully](https://github.com/scullyio/scully).
44

55
| Plugin | npm |
66
| ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |

plugins/rss/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,22 @@
22

33
[![npm version](https://badge.fury.io/js/%40notiz%2Fscully-plugin-rss.svg)](https://www.npmjs.com/package/@notiz/scully-plugin-rss)
44

5-
`scully-plugin-rss` is a `postRenderer` plugin for [Scully](http://scully.io/) adding creating a rss feed from your content using [feed](https://github.com/jpmonette/feed) and [showdown](https://github.com/showdownjs/showdown).
5+
`scully-plugin-rss` is a `routeDiscoveryDone` plugin for [Scully](http://scully.io/). A RSS Feed is created from your content using [feed](https://github.com/jpmonette/feed) and [showdown](https://github.com/showdownjs/showdown).
66

77
The rss feed is available at:
88

99
- your-domain.de/feed.json
1010
- your-domain.de/feed.atom
1111
- your-domain.de/feed.xml
1212

13+
> **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.
14+
1315
## 📦 Installation
1416

15-
To install this plugin with `npm` run
17+
Install the RSS Feed plugin using the command
1618

17-
```
18-
$ npm install @notiz/scully-plugin-rss --save-dev
19+
```bash
20+
npm install @notiz/scully-plugin-rss --save-dev
1921
```
2022

2123
## Usage
@@ -71,7 +73,7 @@ Each RSS Feed item attributes are currently assigned by the following scully rou
7173
| `contributor` | `authors` |
7274
| `date` | `updatedAt` \|  `publishedAt` |
7375

74-
Your content should have the following frontmatter in your scully content:
76+
Your content should have the following front matter in your scully content:
7577

7678
```
7779
---

0 commit comments

Comments
 (0)