mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-30 06:22:23 -05:00
d3927310d5
1798dc0d5 Update theme 403fa716e Update CLI documentation (#2092) aade5a09e Correct media subtype example 53cd9dea6 netlify: Hugo 0.112.3 b78b86cb1 Add source/target warning to resources.Copy (#2091) 50c299729 netlify: Hugo 0.112.2 73197046f Change config.xxx to hugo.xxx throughout the documentation (#2090) d489d4c6f Add hugo.WorkingDir to docs (#2089) 7487df809 Fix typos (#2088) 6d0572cd6 netlify: Hugo 0.112.1 6838600b2 netlify: Hugo 0.112.0 513e7a80f Merge branch 'tempv0.112.0' 91eb44275 Some more about 0.112.0 bd3b33a27 docs: Regen docshelper fb3027daf docs: Regen CLI docs 8e7b8e987 Merge commit 'f96384a3b596f9bc0a3a035970b09b2c601f0ccb' a942ceef4 tpl/tplimpl: Add img loading attribute to figure shortcode (#10927) 0e0c7b25e tpl/urls: Return empty string when JoinPath has zero args 310ce949a tpl/urls: Add JoinPath template function ae435ca77 tpl: Add math.Abs f340139f8 Revert "Update syntax-highlighting.md (#10929)" (#10930) 917a0e24d Update syntax-highlighting.md (#10929) git-subtree-dir: docs git-subtree-split: 1798dc0d54ce048dd975863b490cd809ef14268a
84 lines
2.8 KiB
Markdown
84 lines
2.8 KiB
Markdown
---
|
|
title: Sitemap Templates
|
|
description: Hugo provides built-in sitemap templates.
|
|
categories: [templates]
|
|
keywords: [sitemap, xml, templates]
|
|
menu:
|
|
docs:
|
|
parent: templates
|
|
weight: 160
|
|
weight: 160
|
|
aliases: [/layout/sitemap/,/templates/sitemap/]
|
|
toc: true
|
|
---
|
|
|
|
## 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.
|
|
|
|
{{< code-toggle file="hugo" >}}
|
|
[sitemap]
|
|
changefreq = 'monthly'
|
|
filename = 'sitemap.xml'
|
|
priority = 0.5
|
|
{{</ code-toggle >}}
|
|
|
|
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 >}}
|
|
|
|
[`publishDir`]: /getting-started/configuration#publishdir
|
|
[change frequency]: <https://www.sitemaps.org/protocol.html#changefreqdef>
|
|
[priority]: <https://www.sitemaps.org/protocol.html#priority>
|
|
[sitemap protocol]: <https://www.sitemaps.org/protocol.html>
|
|
[sitemap.xml]: <https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_default/sitemap.xml>
|
|
[sitemapindex.xml]: <https://github.com/gohugoio/hugo/blob/master/tpl/tplimpl/embedded/templates/_default/sitemapindex.xml>
|