Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
@notiz/scully-plugin-rss
Advanced tools
Readme
scully-plugin-rss
is a routeDiscoveryDone
plugin for Scully. A RSS Feed is created from your content using feed and showdown.
The rss feed is available at:
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.
Breaking Change introduced in Version 1.0.0 with changing the plugin type from
render
torouteDiscoveryDone
. This has the major benefit of only generating the RSS Feed once per run instead of after each page render.
Install the RSS Feed plugin using the command
npm install @notiz/scully-plugin-rss --save-dev
Note:
routeDiscoveryDone
plugin requires@scullyio/scully
in version ^1.0.5 or above to correctly parse date values from markdown front matter.
Import the plugin in the Scully config file scully.app-name.config.ts
:
import { ScullyConfig } from '@scullyio/scully';
import '@notiz/scully-plugin-rss';
export const config: ScullyConfig = {
projectRoot: './src/app',
routes: {
...
},
};
It will run on only routes that include /blog
unless specified otherwise in the rss.config.json
file. The order of the posts will be oldest first unless the newestPostsFirst
option is set in the config.
Create a rss.config.json
in your root with the following properties:
{
"title": "Your Title",
"description": "Page description",
"id": "https://your-domain.com",
"link": "https://your-domain.com",
"language": "en",
"image": "https://your-domain.com/featured.png",
"favicon": "https://you-domain.com/favicon.png",
"copyright": "2020 your-domain.com",
"generator": "Page description",
"filename": "feed",
"feedLinks": {
"atom": "https://your-domain.com/feed.atom",
"json": "https://your-domain.com/feed.json",
"xml": "https://your-domain.com/feed.xml"
},
"outDir": "./dist/static",
"categories": ["Categories", "of", "your", "choice"],
"blogPostRouteSlug": "/blog",
"newestPostsFirst": true
}
Each RSS Feed item attributes are currently assigned by the following scully route attributes.
RSS Feed Item | Scully Route |
---|---|
title | title |
id | slug |
link | Config Link + slug |
description | description |
content | articleHTML |
author | authors |
contributor | authors |
date | updatedAt | publishedAt |
Your content should have the following front matter in your scully content:
---
title: Martial Arts Training
description: Best Martial Arts Training
publishedAt: 2020-03-25T10:12:00.000Z
updatedAt: 2020-03-25T10:12:00.000Z
published: true
tags:
- training
- rss
authors:
- Bruce Lee
---
FAQs
scully plugin generate a RSS Feed XML
The npm package @notiz/scully-plugin-rss receives a total of 0 weekly downloads. As such, @notiz/scully-plugin-rss popularity was classified as not popular.
We found that @notiz/scully-plugin-rss demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.