Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gabsedits/feed
A modern, fast, and easy-to-use RSS, JSON and Atom feed generator for Deno.
https://github.com/gabsedits/feed
atom atom-feed atomfeed deno denojs feed feed-generator jsr rss
Last synced: 15 days ago
JSON representation
A modern, fast, and easy-to-use RSS, JSON and Atom feed generator for Deno.
- Host: GitHub
- URL: https://github.com/gabsedits/feed
- Owner: GabsEdits
- License: gpl-3.0
- Created: 2024-10-19T16:14:26.000Z (27 days ago)
- Default Branch: main
- Last Pushed: 2024-10-27T09:30:04.000Z (20 days ago)
- Last Synced: 2024-10-28T01:11:46.589Z (19 days ago)
- Topics: atom, atom-feed, atomfeed, deno, denojs, feed, feed-generator, jsr, rss
- Language: TypeScript
- Homepage:
- Size: 71.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A modern, fast, and easy-to-use RSS, JSON and Atom feed generator for Deno.
Replacement for feed package.
[](https://jsr.io/@feed/feed)
[](https://jsr.io/@feed/feed)
- Build with modern technologies, and the latest standards, using TypeScript and
Deno.
- Using JSR, insuring the best performance, and the best compatibility.
- Supported feed formats: RSS 2.0, Atom 1.0 and JSON Feed 1.1.
- Easy to use, and easy to customize.
- Supports Node.js, and Deno.
- No dependencies.
- Fully tested.
## Getting Started
### Installation
```bash
npx jsr add @feed/feed
```
or
```bash
deno add jsr:@feed/feed
```
### Examples
### Atom Feed
```typescript
import { Atom } from "jsr:@feed/feed";
const atomFeed = new Atom({
title: "Atom Feed Example",
description: "A simple Atom feed example",
link: "http://example.com/atom-feed",
authors: [
{
name: "John Doe",
email: "[email protected]",
},
],
id: "https://example.com/atom-feed",
});
atomFeed.addItem({
title: "First Atom Item",
link: "http://example.com/atom1",
id: "1",
updated: new Date(),
summary: "Summary for Atom item 1",
content: {
body: "Content for Atom item 1",
type: "html",
},
});
Deno.writeTextFileSync("example.xml", atomFeed.build());
```
### RSS Feed
```typescript
import { Rss } from "jsr:@feed/feed";
const rssFeed = new Rss({
title: "RSS Feed Example",
description: "A simple RSS feed example",
link: "http://example.com/rss-feed",
id: "http://example.com/rss-feed",
authors: [
{
name: "John Doe",
email: "[email protected]",
},
],
});
rssFeed.addItem({
title: "First RSS Item",
link: "http://example.com/rss1",
id: "http://example.com/rss1",
updated: new Date("2024-10-19T15:12:56Z"),
description: "Description for RSS item 1",
content: {
body: "Content for RSS item 1",
type: "html",
},
});
Deno.writeTextFileSync("example.rss", rssFeed.build());
```
### JSON Feed
```typescript
import { Json } from "jsr:@feed/feed";
const jsonFeed = new Json({
title: "JSON Feed Example",
description: "A simple JSON feed example",
link: "http://example.com/json-feed",
feed: "http://example.com/json-feed/feed.json",
authors: [
{
name: "John Doe",
email: "[email protected]",
},
],
});
jsonFeed.addItem({
id: "1",
title: "First JSON Item",
url: "http://example.com/json1",
date_published: new Date("2024-10-19T15:12:56Z"),
content_html: "Content for JSON item 1",
});
Deno.writeTextFileSync("example.json", jsonFeed.build());
```
---
## Know your rights
This project is under the GPL-3.0 License:
- **Permissions**: Commercial use, Modification, Distribution, Private use.
- **Limitations**: Liability, Warranty.
- **Conditions**: License and copyright notice. State changes, and Disclose
source.
Read the full license [here](LICENSE.txt).
## Contributing
Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.