Sitemap Generation

Reverb 2.0 generates XML sitemaps following the Sitemaps Protocol. Sitemaps help search engines discover and index all pages in your documentation.

Sitemap Structure

The sitemap generation creates a hierarchical structure:

sitemap.xml

The root sitemap index file that references the root sitemap-pages.xml and all group-level sitemaps. Located in the output root directory. In a federated site, the composition writes this file from the shell target's Sitemap Base URL, listing the shell's sitemap-pages.xml and each composed parcel's.

sitemap-pages.xml

Generated for each document group and placed in the corresponding group folder. Contains URLs for all pages within that group. A root sitemap-pages.xml in the output root directory lists the entry page.

Sitemap XML Format

The generated sitemap.xml follows the sitemap index format:

<?xml version="1.0" encoding="UTF-8"?>
<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <sitemap>
    <loc>https://docs.example.com/help/sitemap-pages.xml</loc>
    <lastmod>2025-01-15</lastmod>
  </sitemap>
  <sitemap>
    <loc>https://docs.example.com/help/group1/sitemap-pages.xml</loc>
    <lastmod>2025-01-15</lastmod>
  </sitemap>
  <sitemap>
    <loc>https://docs.example.com/help/group2/sitemap-pages.xml</loc>
    <lastmod>2025-01-15</lastmod>
  </sitemap>
</sitemapindex>

Each sitemap-pages.xml contains individual page entries:

<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <url>
    <loc>https://docs.example.com/help/group1/page1.html</loc>
    <lastmod>2025-01-15</lastmod>
  </url>
</urlset>

Note: If the Sitemap Base URL setting is empty, sitemap.xml is generated as an empty sitemapindex, each sitemap-pages.xml as an empty urlset, and a warning appears in the build log. In a federated site, the composed sitemap.xml is also empty, and the composition warns. Always configure the base URL before deploying to production.

Last modified date: 11/05/2026