RSS

Heyo Docs publishes an RSS 2.0 feed at /rss.xml for changelog updates. It reads the same MDX <Update> entries that power the changelog UI, so feed items, tags, descriptions, and anchors stay in sync with the rendered page.

Only pages selected by a changelog group are included. Ordinary documentation pages are deliberately excluded from the feed.

Define changelog updates

Configure a group with type: "changelog" and point updates at the MDX pages that contain the entries:

export default heyoDocs({
  siteUrl: "https://docs.example.com",
  groups: [
    {
      group: "Changelog",
      type: "changelog",
      updates: ["changelog"],
    },
  ],
  // ...the rest of the configuration
});

Each <Update> needs a label. tags and the ISO 8601 date are optional, but a date allows the feed to emit an RSS pubDate.

---title: Changelog---# Changelog<Update  label="Version 2.4"  date="2026-08-24"  tags={["New releases", "Search"]}>## Faster documentation searchImproved result ranking for API operations.</Update>

The feed creates an item URL from the documentation URL and the update anchor, for example https://docs.example.com/changelog#version-2-4. It includes the plain-text update body as the description and turns each tag into an RSS category. Text is XML-escaped before it is returned.

The document is served with:

content-type: application/rss+xml; charset=utf-8

When a changelog group exists, the root layout also advertises the feed with a rel="alternate" link so browsers and feed readers can discover it.

React Router

Create a project

The React Router template includes /rss.xml, adds it to prerender(), and places the discovery link in the root document whenever a changelog group is configured.

bun create @heyo-sh/heyo-docs my-docs --template react-router

Manual, minimal configuration

Register the resource route before the documentation catch-all:

route("rss.xml", "routes/rss.ts"),
route("*", "routes/docs.tsx"),

Generate the feed from the server-side virtual MDX registry:

import { rssXml } from "@heyo-sh/heyo-docs";
import type { LoaderFunctionArgs } from "react-router";

import config from "../../heyo-docs.config";
import { pages } from "virtual:heyo-docs-content/server";

export function loader({ request }: LoaderFunctionArgs) {
  const siteUrl = config.siteUrl ?? new URL(request.url).origin;
  return new Response(rssXml(pages, config, siteUrl), {
    headers: { "content-type": "application/rss+xml; charset=utf-8" },
  });
}

Include /rss.xml in the prerender() result for static deployments. Add the discovery link conditionally in app/root.tsx:

export const links = () =>
  config.groups.some((group) => group.type === "changelog")
    ? [
        {
          rel: "alternate",
          href: "/rss.xml",
          type: "application/rss+xml",
          title: `${config.title} updates`,
        },
      ]
    : [];

Next.js

Create a project

The Next.js template adds an App Router Route Handler and declares the feed as an alternate type in root metadata when a changelog exists.

bun create @heyo-sh/heyo-docs my-docs --template next

Manual, minimal configuration

After generating and exporting config and markdownPages from the server- only docs helper, add the route:

import { rssXml } from "@heyo-sh/heyo-docs/node";

import { config, markdownPages } from "../lib/docs";

export function GET(request: Request) {
  const siteUrl = config.siteUrl ?? new URL(request.url).origin;
  return new Response(rssXml(markdownPages, config, siteUrl), {
    headers: { "content-type": "application/rss+xml; charset=utf-8" },
  });
}

For discovery, set alternates.types["application/rss+xml"] to "/rss.xml" in the root Metadata only when a changelog group is present.

Astro

Create a project

The Astro template includes a static src/pages/rss.xml.ts API route and an RSS alternate link in DocsLayout when the configuration has a changelog.

bun create @heyo-sh/heyo-docs my-docs --template astro

Manual, minimal configuration

Create the root API route and generate the feed from the server page registry:

import type { APIRoute } from "astro";
import { rssXml } from "@heyo-sh/heyo-docs";

import config from "../../heyo-docs.config";
import { pages } from "virtual:heyo-docs-content/server";

export const GET: APIRoute = ({ request }) => {
  const siteUrl = config.siteUrl ?? new URL(request.url).origin;
  return new Response(rssXml(pages, config, siteUrl), {
    headers: { "content-type": "application/rss+xml; charset=utf-8" },
  });
};