mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-03 19:38:26 -05:00
75 lines
2.3 KiB
Markdown
75 lines
2.3 KiB
Markdown
|
---
|
|||
|
|
title: Sitemap Template
|
|||
|
|
# linktitle: Sitemap
|
|||
|
|
description: Hugo ships with a built-in template file observing the v0.9 of the Sitemap Protocol, but you can override this template if needed.
|
|||
|
|
date: 2017-02-01
|
|||
|
|
publishdate: 2017-02-01
|
|||
|
|
lastmod: 2017-02-01
|
|||
|
|
categories: [templates]
|
|||
|
|
#tags: [sitemap, xml]
|
|||
|
|
menu:
|
|||
|
|
docs:
|
|||
|
|
parent: "templates"
|
|||
|
|
weight: 160
|
|||
|
|
weight: 160
|
|||
|
|
sections_weight: 160
|
|||
|
|
draft: false
|
|||
|
|
aliases: [/layout/sitemap/,/templates/sitemap/]
|
|||
|
|
toc: false
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
A single Sitemap template is used to generate the `sitemap.xml` file.
|
|||
|
|
Hugo automatically comes with this template file. *No work is needed on
|
|||
|
|
the users' part unless they want to customize `sitemap.xml`.*
|
|||
|
|
|
|||
|
|
A sitemap is a `Page` and therefore has all the [page variables][pagevars] available to use in this template along with Sitemap-specific ones:
|
|||
|
|
|
|||
|
|
`.Sitemap.ChangeFreq`
|
|||
|
|
: The page change frequency
|
|||
|
|
|
|||
|
|
`.Sitemap.Priority`
|
|||
|
|
: The priority of the page
|
|||
|
|
|
|||
|
|
`.Sitemap.Filename`
|
|||
|
|
: The sitemap filename
|
|||
|
|
|
|||
|
|
If provided, Hugo will use `/layouts/sitemap.xml` instead of the internal `sitemap.xml` template that ships with Hugo.
|
|||
|
|
|
|||
|
|
## Hugo’s sitemap.xml
|
|||
|
|
|
|||
|
|
This template respects the version 0.9 of the [Sitemap Protocol](http://www.sitemaps.org/protocol.html).
|
|||
|
|
|
|||
|
|
```
|
|||
|
|
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
|||
|
|
{{ range .Data.Pages }}
|
|||
|
|
<url>
|
|||
|
|
<loc>{{ .Permalink }}</loc>{{ if not .Lastmod.IsZero }}
|
|||
|
|
<lastmod>{{ safeHTML ( .Lastmod.Format "2006-01-02T15:04:05-07:00" ) }}</lastmod>{{ end }}{{ with .Sitemap.ChangeFreq }}
|
|||
|
|
<changefreq>{{ . }}</changefreq>{{ end }}{{ if ge .Sitemap.Priority 0.0 }}
|
|||
|
|
<priority>{{ .Sitemap.Priority }}</priority>{{ end }}
|
|||
|
|
</url>
|
|||
|
|
{{ end }}
|
|||
|
|
</urlset>
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
{{% note %}}
|
|||
|
|
Hugo will automatically add the following header line to this file
|
|||
|
|
on render. Please don't include this in the template as it's not valid HTML.
|
|||
|
|
|
|||
|
|
`<?xml version="1.0" encoding="utf-8" standalone="yes" ?>`
|
|||
|
|
{{% /note %}}
|
|||
|
|
|
|||
|
|
## Configure `sitemap.xml`
|
|||
|
|
|
|||
|
|
Defaults for `<changefreq>`, `<priority>` and `filename` values can be set in the site's config file, e.g.:
|
|||
|
|
|
|||
|
|
```
|
|||
|
|
[sitemap]
|
|||
|
|
changefreq = "monthly"
|
|||
|
|
priority = 0.5
|
|||
|
|
filename = "sitemap.xml"
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
The same fields can be specified in an individual content file's front matter in order to override the value assigned to that piece of content at render time.
|
|||
|
|
|
|||
|
|
[pagevars]: /variables/page/
|