hugo/docs/content/templates/sitemap.md

66 lines
2 KiB
Markdown
Raw Normal View History

2014-05-07 06:58:25 +00:00
---
2014-05-29 22:42:05 +00:00
aliases:
- /layout/sitemap/
lastmod: 2015-12-10
2014-05-29 22:42:05 +00:00
date: 2014-05-07
linktitle: Sitemap
2014-05-07 06:58:25 +00:00
menu:
main:
2014-05-29 22:42:05 +00:00
parent: layout
next: /templates/404
notoc: true
prev: /templates/rss
title: Sitemap Template
weight: 95
2014-05-07 06:58:25 +00:00
---
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`.**
2014-05-07 06:58:25 +00:00
This page is of the type "node" and have all the [node
variables](/layout/variables/) available to use in this template
along with Sitemap-specific ones:
**.Sitemap.ChangeFreq** The page change frequency<br>
**.Sitemap.Priority** The priority of the page<br>
2015-12-10 19:39:06 +00:00
**.Sitemap.Filename** The sitemap filename<br>
2014-05-07 06:58:25 +00:00
In addition to the standard node variables, the homepage has access to all
site pages through `.Data.Pages`.
If provided, Hugo will use `/layouts/sitemap.xml` instead of the internal
one.
2014-05-07 06:58:25 +00:00
## Hugos sitemap.xml
2014-05-07 06:58:25 +00:00
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>
<lastmod>{{ safeHTML ( .Date.Format "2006-01-02T15:04:05-07:00" ) }}</lastmod>{{ with .Sitemap.ChangeFreq }}
<changefreq>{{ . }}</changefreq>{{ end }}{{ if ge .Sitemap.Priority 0.0 }}
<priority>{{ .Sitemap.Priority }}</priority>{{ end }}
</url>
{{ end }}
</urlset>
2014-05-07 06:58:25 +00:00
***Important:** 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.*
2014-05-07 06:58:25 +00:00
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
## Configuring sitemap.xml
2015-12-10 19:39:06 +00:00
Defaults for `<changefreq>`, `<priority>` and `filename` values can be set in the site's config file, e.g.:
[sitemap]
changefreq = "monthly"
priority = 0.5
2015-12-10 19:39:06 +00:00
filename = "sitemap.xml"
2015-12-10 19:39:06 +00:00
The same fields can be specified in an individual page's front matter in order to override the value for that page.