hugo/docs/content/templates/sitemap.md

---
aliases:
- /layout/sitemap/
date: 2014-05-07
linktitle: Sitemap
menu:
  main:
    parent: layout
next: /templates/404
notoc: true
prev: /templates/rss
title: Sitemap Template
weight: 95
---

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`.**

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.

## 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>
        <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>

***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.*

    <?xml version="1.0" encoding="utf-8" standalone="yes" ?>
-												Add Sitemap documentation content

											
										
										
											2014-05-07 06:58:25 +00:00
+								---
-												Converting front matter to YAML

											
										
										
											2014-05-29 22:42:05 +00:00
+								aliases:
 								- /layout/sitemap/
 								date: 2014-05-07
 								linktitle: Sitemap
-												Add Sitemap documentation content

											
										
										
											2014-05-07 06:58:25 +00:00
+								menu:
 								  main:
-												Converting front matter to YAML

											
										
										
											2014-05-29 22:42:05 +00:00
+								    parent: layout
 								next: /templates/404
 								notoc: true
 								prev: /templates/rss
 								title: Sitemap Template
 								weight: 95
-												Add Sitemap documentation content

											
										
										
											2014-05-07 06:58:25 +00:00
+								---
 								A single Sitemap template is used to generate the `sitemap.xml` file.
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								Hugo automatically comes with this template file. **No work is needed on
-												Docs: Minor copyediting/proofreading

- Correct some typos
- Add backticks and commas where necessary
- Use fenced code blocks specifying "bash" as the language
  to avoid weird highlighting
- Place commas outside of quotation marks surroundingn codes
  to avoid possible confusion
- Suggest users to use the discussion forum rather than the
  mailing list

											
										
										
											2014-12-04 16:26:12 +00:00
+								the users' part unless they want to customize `sitemap.xml`.**
-												Add Sitemap documentation content

											
										
										
											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>
 								In addition to the standard node variables, the homepage has access to all
 								site pages through `.Data.Pages`.
-												Docs: Minor copyediting/proofreading

- Correct some typos
- Add backticks and commas where necessary
- Use fenced code blocks specifying "bash" as the language
  to avoid weird highlighting
- Place commas outside of quotation marks surroundingn codes
  to avoid possible confusion
- Suggest users to use the discussion forum rather than the
  mailing list

											
										
										
											2014-12-04 16:26:12 +00:00
+								If provided, Hugo will use `/layouts/sitemap.xml` instead of the internal
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
+								one.
-												Add Sitemap documentation content

											
										
										
											2014-05-07 06:58:25 +00:00
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
+								## Hugo’s sitemap.xml
-												Add Sitemap documentation content

											
										
										
											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).
-												Switching docs highlighting to highlight.js .. Docs build super fast again!

											
										
										
											2014-05-15 13:58:55 +00:00
+								    <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
 								      {{ range .Data.Pages }}
 								      <url>
 								        <loc>{{ .Permalink }}</loc>
-												Update Hugo docs with the initialisms suggested by golint

In particular:

 * .Url → .URL (for node, menu and paginator)
 * .Site.BaseUrl → .Site.BaseURL
 * getJson → getJSON
 * getCsv → getCSV
 * safeHtml → safeHTML
 * safeCss → safeCSS
 * safeUrl → safeURL

Continued effort in fixing #959.

											
										
										
											2015-03-18 06:44:12 +00:00
+								        <lastmod>{{ safeHTML ( .Date.Format "2006-01-02T15:04:05-07:00" ) }}</lastmod>{{ with .Sitemap.ChangeFreq }}
-												Switching docs highlighting to highlight.js .. Docs build super fast again!

											
										
										
											2014-05-15 13:58:55 +00:00
+								        <changefreq>{{ . }}</changefreq>{{ end }}{{ if ge .Sitemap.Priority 0.0 }}
 								        <priority>{{ .Sitemap.Priority }}</priority>{{ end }}
 								      </url>
 								      {{ end }}
 								    </urlset>
-												Add Sitemap documentation content

											
										
										
											2014-05-07 06:58:25 +00:00
-												Docs: Minor copyediting/proofreading

- Correct some typos
- Add backticks and commas where necessary
- Use fenced code blocks specifying "bash" as the language
  to avoid weird highlighting
- Place commas outside of quotation marks surroundingn codes
  to avoid possible confusion
- Suggest users to use the discussion forum rather than the
  mailing list

											
										
										
											2014-12-04 16:26:12 +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.*
-												Add Sitemap documentation content

											
										
										
											2014-05-07 06:58:25 +00:00
 								    <?xml version="1.0" encoding="utf-8" standalone="yes" ?>