NAME

byterazor::HiD::Sitemap - sitemap.xml generator

VERSION

version 0.2

DESCRIPTION

This Generator produces a sitemap.xml for your site, containing all published pages and posts.

Enable it by adding +byterazor::HiD::Sitemap to the plugins key in your config. The + prefix tells HiD to use the full class name rather than looking in the HiD::Generator:: namespace:

plugins:
  - '+byterazor::HiD::Sitemap'
sitemap:
  generate: 1

You may set the following additional sitemap.* config keys:

sitemap.destination

Where to write the sitemap, relative to the site destination. Defaults to sitemap.xml.

sitemap.baseurl

Absolute base URL of the site, prefixed to every entry. Falls back to the site-wide baseurl config key. Sitemaps require absolute URLs, so you should set this (a warning is emitted otherwise).

sitemap.lastmod

Whether to include <lastmod> elements. Defaults to 1. For posts the post date is used; for pages the modification time of the input file. Set to 0 to omit.

sitemap.exclude

Arrayref of regexes; URLs matching any of them are left out of the sitemap.

METHODS

generate

_lastmod

Returns a W3C-datetime lastmod string for the object: the post date for posts, the modification time of the input file for pages, or undef if neither is available.

_render

Renders the entries as a sitemap.xml document.

AUTHOR

Dominik Meyer <dmeyer@federationhq.de>

COPYRIGHT AND LICENSE

This software is copyright (c) 2026 by Dominik Meyer.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.