Sitemap-Index

The Sitemap-Index header can optionally be set on the root node to enable or disable writing a sitemap index, along with multiple sitemap files.

There are two possible values:

The default value is false

If the Sitemap-URL header is not set, then Sitemap-Index will have no effect.

When Sitemap-Index is set to false, then only a single sitemap file will be written to the path specified by Sitemap-URL.

When Sitemap-Index is set to true, then a sitemap index will be written at the path specified by Sitemap-URL, instead of a sitemap. This sitemap index will contain links to additional sitemap files, which will also be written dynamically.

The individual sitemap files will be based on the Sitemap-URL path, with numbers added to each file.

For example, if Sitemap-URL is set to /sitemap.xml.gz, Sitemap-Index is set to true, and three sitemap files end up being generated, then the following files will appear in the public directory when the site is built:

sitemap.xml.gz
sitemap-001.xml.gz
sitemap-002.xml.gz
sitemap-003.xml.gz

The Sitemap-Max-Files header controls the maximum number of sitemap files that will be written.

The Sitemap-Max-Entries header controls the maximum number of entries that will be written to each individual sitemap file.

See the RSS, Sitemap, robots.txt page for additional details about how to generate a sitemap.

Tags: headers, root-node, sitemap, sitemap-headers

This page was generated by Uriel with the following settings:

Page Details

Resource Path Project File
Node headers/sitemap-index nodes/headers/sitemap-index
Template default.html templates/default.html
URL /headers/sitemap-index/ public/headers/sitemap-index/index.html

Node Headers

Header (Lowercase) Value
tags headers, root-node, sitemap, sitemap-headers
title Sitemap-Index
+-tags *
breadcrumb-separator »
canonical-url https://documentation.uriel.foo
rss-description Uriel Documentation
rss-image-height 32
rss-image-url /favicon-32x32.png
rss-image-width 32
rss-max-entries 50
rss-title Uriel Documentation
rss-url /rss.xml
sitemap-max-entries 10000
sitemap-url /sitemap.xml
tag-node tag
template default.html

Node Timestamps

Type Value
Created
Modified 2026-06-15T22:12:39-04:00

Node Methods

Method Value
get_parent_node() headers/index
get_path() headers/sitemap-index
get_node_type() file
get_url() /headers/sitemap-index/
get_canonical_url() https://documentation.uriel.foo/headers/sitemap-index/
get_name() sitemap-index
get_display_name() Sitemap Index
get_title() Sitemap-Index
get_escaped_title() Sitemap-Index
get_link() <a href="/headers/sitemap-index/">Sitemap-Index</a>
get_canonical_link() <a href="https://documentation.uriel.foo/headers/sitemap-index/">Sitemap-Index</a>
get_link_prefix() <p>
get_link_suffix() </p>
get_tags() ['headers', 'root-node', 'sitemap', 'sitemap-headers']
get_dest_dir() ./public/headers/sitemap-index
get_dest_file() ./public/headers/sitemap-index/index.html
get_breadcrumb_separator() &raquo;