Modules
Sitemap generation: streaming, parallel and incremental.
Storage behaviour used to publish, read, list and delete sitemap files.
Stores sitemaps in a local directory, including network mounts (NFS, EFS, SMB) and container volumes.
In-memory storage backed by an Agent, meant for tests.
Discards every write. Useful for dry runs that only report counts through telemetry.
Stores sitemaps in Cloudflare R2, through its S3-compatible API.
Stores sitemaps in AWS S3 or any S3-compatible service (MinIO, DigitalOcean Spaces, Wasabi, Ceph, Google Cloud Storage interoperability).
Validated configuration of a sitemap module. Options are given to use SiteMaps, read from the
application environment when :otp_app is set, and returned by the optional
SiteMaps.config/1 callback, in that order of precedence, later sources winning.
W3C datetime normalization and formatting for sitemap dates.
A single sitemap entry is larger than the configured max_bytes of a file.
Raised by SiteMaps.generate!/2 when generation fails.
A <sitemap> entry of a sitemap index.
Storage keys of the files written by a process execution.
Oban worker that runs SiteMaps.generate/2. Compiled only when Oban is available.
Serves generated sitemaps and the built-in XSL stylesheets.
A sitemap process declared with SiteMaps.process/3.
Outcome of SiteMaps.generate/2.
Renders a robots.txt pointing crawlers to the sitemaps.
Telemetry events emitted while generating sitemaps.
A <url> entry of a urlset, validated and normalized by new/2.
iodata rendering of urlsets and sitemap indexes.
Mix Tasks
Generates a starter module that uses SiteMaps, with a static process and a dynamic process
sharded by month, written through the SiteMaps.Adapters.FileSystem adapter.
Generates the sitemaps of a module that uses SiteMaps.