Search documentation of phoenix_kit

# PhoenixKit.Sitemap.Sources.Static (phoenix_kit v1.6.19)

View Source

Static routes source for sitemap generation.

Collects configurable static routes for the sitemap. Routes are configured through Settings and resolved via RouteResolver - NO hardcoded fallbacks.

## Settings

- `sitemap_static_routes` - JSON array of route configurations
- `sitemap_custom_urls` - JSON array of custom URL entries

## Route Configuration Format

Each route in `sitemap_static_routes` can have:

    %{
      "plug" => "PhoenixKitWeb.Users.Registration",  # Module to resolve via RouteResolver
      "path" => "/custom/path",                       # OR explicit path (overrides plug)
      "priority" => 0.7,                              # Sitemap priority (0.0-1.0)
      "changefreq" => "monthly",                      # Change frequency
      "title" => "Register",                          # Display title
      "category" => "Authentication",                 # Category for grouping
      "prefixed" => true                              # Use PhoenixKit URL prefix
    }

## Custom URL Format

Each entry in `sitemap_custom_urls`:

    %{
      "path" => "/about-us",
      "priority" => 0.8,
      "changefreq" => "monthly",
      "title" => "About Us",
      "category" => "Company"
    }

## Default Configuration

By default, includes:

- Homepage (/) - Priority: 0.9, daily
- Registration page - Priority: 0.7, monthly (if route exists)
- Login page - Priority: 0.7, monthly (if route exists)

## No Hardcoded Fallbacks

If RouteResolver cannot find a route and no explicit path is configured, the route is skipped. This ensures sitemap only contains valid URLs.