Back to Hugo

Sitemap templates

docs/content/en/templates/sitemap.md

0.161.11.5 KB
Original Source

Overview

Hugo's embedded sitemap templates conform to v0.9 of the sitemap protocol.

With a monolingual project, Hugo generates a sitemap.xml file in the root of the publishDir using the embedded sitemap template.

With a multilingual project, Hugo generates:

Configuration

See configure sitemap.

Override default values

Override the default values for a given page in front matter.

{{< code-toggle file=news.md fm=true >}} title = 'News' [sitemap] changefreq = 'weekly' disable = true priority = 0.8 {{</ code-toggle >}}

Override built-in templates

To override the built-in sitemap.xml template, create a new layouts/sitemap.xml file. When ranging through the page collection, access the change frequency and priority with .Sitemap.ChangeFreq and .Sitemap.Priority respectively.

To override the built-in sitemapindex.xml template, create a new layouts/sitemapindex.xml file.

Disable sitemap generation

You may disable sitemap generation in your project configuration:

{{< code-toggle file=hugo >}} disableKinds = ['sitemap'] {{</ code-toggle >}}