Skip to content
Atom Feeds
Updated
On this page

How selfdoc generates an Atom feed from your documentation pages, with date handling, page exclusion, and feed size limits.

#Atom Feeds

Every selfdoc site gets a feed.xml in the build output. It is a standard Atom 1.0 feed that RSS readers, news aggregators, and automation tools can subscribe to. No setup required -- it happens automatically during selfdoc build.

#How It Works

The build pipeline collects all documentation pages, extracts their titles and first sentences, sorts them by date (most recent first), and writes a valid Atom XML file. Each page becomes one <entry> in the feed with a title, link, summary, and updated timestamp.

Every generated HTML page includes a <link rel="alternate" type="application/atom+xml"> tag in the <head>, so browsers and feed readers can auto-discover the feed.

#Date Handling

selfdoc determines page dates from 2 sources, checked in priority order. Accurate dates are important because they control the sort order of feed entries and the feed-level <updated> element that readers use to detect new content. The 2 sources are:

  1. Frontmatter fields -- date and updated in your page's frontmatter, each written as a bare TOML local date. If updated is present, it takes precedence. Format: YYYY-MM-DD.
  2. File modification time -- if no frontmatter date is set, selfdoc falls back to the file's last-modified timestamp from git (or the filesystem if git is unavailable).
M markdown
++
title = "My Page"
date = 2025-03-15
updated = 2025-04-02
++

The feed-level <updated> element uses the most recent date across all pages.

#Excluding Pages from the Feed

Set feed = false in a page's frontmatter to keep it out of the feed. This is useful for pages that are not meaningful as feed entries -- like the glossary, changelog, or auto-generated API reference pages.

M markdown
++
title = "Glossary"
feed = false
++

Pages without this field (or with feed = true) are included by default.

#Limiting Feed Size

By default the feed includes all pages sorted by date, which can grow large for documentation sites with hundreds of pages. For large sites, cap the number of entries with the feed_max_entries config option in selfdoc.json to keep the feed lightweight for subscribers:

{} json
{
  "feed_max_entries": 20
}

This keeps only the 20 most recently updated pages in the feed. Older entries are dropped. The value must be a positive integer; omit it or set it to null for no limit.

#Subscribing

Point any Atom/RSS reader at https://your-site.example.com/feed.xml to subscribe to documentation updates. Most modern readers auto-detect the feed from any page URL thanks to the <link rel="alternate" type="application/atom+xml"> tag that selfdoc includes in every HTML page head.

Common readers that work:

  • Feedly, Inoreader, NewsBlur -- paste your site URL, they find the feed automatically
  • Thunderbird, NetNewsWire -- add the feed URL directly
  • GitHub Actions / webhooks -- poll feed.xml to trigger automations when docs update
Tip

Make sure base_url is set in your selfdoc.json. The feed uses absolute URLs for entry links, and without base_url those links will be broken.

Next: llms.txt -->

More tools from this site

  • claudestream Drive Claude Code from Python: run it as a subprocess and read its output as typed events, with async and sync sessions, sandbox policies, and tools you define in Python
  • claudewheel A TUI Claude Code Launcher that lets you have more than one profile, manage sessions lifecycle, pick the exact CC version, model to use (even older unlisted ones), pick which GitHub account to use, etc.
  • dirstat Fast, single-binary directory statistics CLI: every file under a tree grouped by format, with counts, sizes, and lines of code, as a colored terminal table or as JSON
  • fastware A batteries-included ASGI framework: msgspec JSON, a managed Granian server, dependency injection, SSE, WebSockets, auth, and a test client
  • go-toml-edit Zero-dep TOML editing library for Go with comment preservation
  • howmuchleft The fastest Claude Code statusline: context window, 5-hour, and weekly limit usage as three customizable gradient bars, rendering in about 6 ms
  • orxtra
  • pgdesign
  • predraw Declarative rendering pipeline: describe a scene in JSON and get SVG, PNG and WebP out, with light and dark style tokens, reusable components and text converted to path outlines
  • reposummary Turn a git repository's history into a Markdown journal: pick a time window or revision range and get a readable digest of what changed, optionally narrated by an LLM
  • rlsbl Release orchestration and project scaffolding CLI that bumps versions, validates a structured JSONL changelog, tags only the commit CI verified, and publishes to npm, PyPI, Go and more
  • safegit git wrapper CLI that gives each commit its own temporary index and retries ref updates on conflict, so concurrent agents share one repository
  • saferm Command-line replacement for rm that archives every deletion with a mandatory reason and the context it ran in, so deleted files can be listed, inspected and restored
  • strictcli
  • stricttest An always-on test-isolation floor: a pytest plugin and a Go env-hygiene module that make a test suite structurally unable to reach real credentials, the real HOME, the network, or the development repository.
  • wesktop A Python framework that turns an ASGI web app into a desktop application, serving it from a local Granian server and displaying it in a native OS window via pywebview
Search