ZFeed

Modern feed generator for RSS, Atom and JSON. Forked and rewritten from jpmonette/feed.

Tiny, tree-shakable and zero dependencies.

Installation

pnpm i zfeed

Usage

import { createFeed, generateAtom1, generateJson1, generateRss2 } from "zfeed";

export const feed = createFeed({
  title: "Feed Title",
  description: "This is my personnal feed!",
  id: "http://example.com/",
  link: "http://example.com/",
  feed: {
    atom: "http://example.com/atom",
    json: "http://example.com/json",
    rss: "http://example.com/rss",
  },
  language: "en-US",
  generator: "https://example.com/generator",
  stylesheet: "http://example.com/style.xsl",
  image: "http://example.com/image.png",
  favicon: "http://example.com/favicon.ico",
  copyright: "Copyright © 2025 KazariEX",
  updatedAt: new Date(2019, 6, 19),
  publishedAt: new Date(2019, 8, 30),

  author: {
    name: "KazariEX",
    email: "[email protected]",
    link: "https://example.com/kazariex",
  },

  contributors: [
    {
      name: "Mimori",
      email: "[email protected]",
      link: "https://example.com/mimori",
    },
  ],

  categories: [
    { term: "Anime" },
    { term: "Novel" },
  ],

  items: [
    {
      title: "Hello World",
      id: "https://example.com/hello-world?id=this&that=true",
      link: "https://example.com/hello-world",
      updatedAt: new Date(2019, 6, 19),
      description: "This is an article about Hello World.",
      content: "Content of the item.",
      author: [
        {
          name: "Mimori",
          email: "[email protected]",
          link: "https://example.com/mimori",
        },
        {
          name: "Yamabuki",
          email: "[email protected]",
          link: "https://example.com/yamabuki",
        },
        {
          name: "Yamabuki, Name Only",
        },
      ],
      contributors: [
        {
          name: "Kumoyo",
          email: "[email protected]",
          link: "https://example.com/kumoyo",
        },
        {
          name: "Moriya",
          email: "[email protected]",
          link: "https://example.com/moriya",
        },
      ],
      image: "https://example.com/hello-world.jpg",
    },
  ],
});

// Atom 1.0
const atom1 = generateAtom1(feed);

// JSON Feed 1.1
const json1 = generateJson1(feed);

// RSS 2.0
const rss2 = generateRss2(feed);

Plugin System

ZFeed has a simple plugin system to extend the functionality of the feed.

First, define a plugin:

import { definePlugin } from "zfeed";

export default definePlugin(() => {
  return {
    name: "zfeed-plugin-testify",
    type: "rss2",
    resolve(feed, data) {
      data.rss["$xmlns:testify"] = "http://testify.com/schemas/1.0";
      data.rss.channel["testify:image"] = { $href: feed.image };
    }
  }
});

Then you can use the plugin in your feed:

import { createFeed } from "zfeed";
import testify from "zfeed-plugin-testify";

const feed = createFeed({
  /* general options */
  plugins: [
    testify(),
  ],
});

Builtin plugins

• @zfeed/plugin-podcast: Adds podcast support.