Skip to main content

guides/features/feeds-and-sitemaps.md

# Feeds and Sitemaps

Astral ships built-in plugins for feed and sitemap generation in static sites.

## Feed

```elixir
plugin Astral.Plugin.Feed,
  site_url: "https://example.com",
  title: "My Blog",
  author: "Astral",
  collection: :posts
```

The feed plugin renders a generated route, usually `/feed.xml`, from collection entries. It reads entry titles, dates, descriptions, authors, and draft status from schema-normalized `entry.data`, so declare those fields in the collection schema when you want them in feeds.

## Sitemap

```elixir
plugin Astral.Plugin.Sitemap,
  site_url: "https://example.com",
  changefreq: :weekly,
  priority: fn page -> if page.route_path == "/", do: 1.0, else: 0.7 end
```

The sitemap plugin renders `/sitemap.xml` from discovered and generated routes. For collection entry pages, default `<lastmod>` uses schema-normalized `entry.data[:updated]` or `entry.data[:date]`; standalone pages use their page frontmatter metadata.

## Custom generated XML routes

For site-specific generated files, implement `Astral.Plugin` and return routes:

```elixir
defmodule MySite.FeedPlugin do
  @behaviour Astral.Plugin

  @impl true
  def name, do: "feed"

  @impl true
  def routes(site) do
    [Astral.Route.new("/feed.xml", site.config, content_type: "application/atom+xml")]
  end

  @impl true
  def render_route(%Astral.Route{path: "/feed.xml"}, site) do
    {:ok, MySite.Feed.render(site.entries.posts)}
  end

  def render_route(_route, _site), do: nil
end
```

Use this pattern for feeds, JSON indexes, search documents, or other static generated assets. Prefer `entry.data` for schema-normalized collection values and `entry.metadata` only when you intentionally need raw frontmatter.