hugo/docs/content/templates/sitemap.md

53 lines
1.6 KiB
Markdown
Raw Normal View History

2014-05-07 02:58:25 -04:00
---
2014-05-29 18:42:05 -04:00
aliases:
- /layout/sitemap/
date: 2014-05-07
linktitle: Sitemap
2014-05-07 02:58:25 -04:00
menu:
main:
2014-05-29 18:42:05 -04:00
parent: layout
next: /templates/404
notoc: true
prev: /templates/rss
title: Sitemap Template
weight: 95
2014-05-07 02:58:25 -04: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 02:58:25 -04: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>
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 02:58:25 -04:00
## Hugos sitemap.xml
2014-05-07 02:58:25 -04: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 02:58:25 -04: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 02:58:25 -04:00
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>