Behaviour for sitemap data sources.

Each source module must implement this behaviour to provide URL entries for sitemap generation. Sources can collect data from various PhoenixKit modules like Entities, Publishing, Pages, etc.

Implementing a Source

defmodule PhoenixKit.Modules.Sitemap.Sources.MyModule do
  @behaviour PhoenixKit.Modules.Sitemap.Sources.Source

  alias PhoenixKit.Modules.Sitemap.UrlEntry

  @impl true
  def source_name, do: :my_module

  @impl true
  def enabled?, do: MyModule.enabled?()

  @impl true
  def collect(_opts) do
    if enabled?() do
      # Collect URLs from your module
      [
        UrlEntry.new(%{
          loc: "https://example.com/my-page",
          lastmod: DateTime.utc_now(),
          changefreq: "weekly",
          priority: 0.8,
          title: "My Page",
          category: "My Module",
          source: :my_module
        })
      ]
    else
      []
    end
  end
end

Adding Source to Generator

After implementing the source, add it to the generator's source list in PhoenixKit.Modules.Sitemap.Generator.collect_all_entries/2.