hugo/docs/content/en/templates/sitemap-template.md at 9beb61416cb51a1ff111ca52f2486210ab825f03

mirror of https://github.com/gohugoio/hugo.git synced 2024-07-02 23:30:00 +00:00

Bjørn Erik Pedersen 5fd1e74903

Merge commit '9b0050e9aabe4be65c78ccf292a348f309d50ccd' as 'docs'

```
git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash
```

Closes #11925

2024-01-27 10:48:57 +01:00

2.7 KiB

Raw Blame History

title

description

Overview

Hugo's built-in 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 built-in sitemap.xml template.

With a multilingual project, Hugo generates:

A sitemap.xml file in the root of each site (language) using the built-in sitemap.xml template
A sitemap.xml file in the root of the publishDir using the built-in sitemapindex.xml template

Configuration

Set the default values for change frequency and priority, and the name of the generated file, in your site configuration.

changefreq: How frequently a page is likely to change. Valid values are always, hourly, daily, weekly, monthly, yearly, and never. Default is "" (change frequency omitted from rendered sitemap).
filename: The name of the generated file. Default is sitemap.xml.
priority: The priority of a page relative to any other page on the site. Valid values range from 0.0 to 1.0. Default is -1 (priority omitted from rendered 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' priority = 0.8 {{</ code-toggle >}}

Override built-in templates

To override the built-in sitemap.xml template, create a new file in either of these locations:

layouts/sitemap.xml
layouts/_default/sitemap.xml

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 file in either of these locations:

layouts/sitemapindex.xml
layouts/_default/sitemapindex.xml

Disable sitemap generation

You may disable sitemap generation in your site configuration:

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

2.7 KiB Raw Blame History