mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
ba45da9d03
32356e4e Fix typo in header of shortcode-templates.md c8f1a2d2 Correct code example for index template function bfa6a55d Escape code fencing ff8b2f99 Fix typos in deployment with wercker tutorial 557c36e8 theme: Merge commit '7fbb4bed25001182bfeb91f79db0f0c1936582ee' 7fbb4bed Squashed 'themes/gohugoioTheme/' changes from 7dd8a302..ca53082d ce31cee0 Add "See Also" config 158cee1b Make the tags into keywords 61600be6 Add a note to the related section 49edb5a2 Relase 0.27.1 c9bbc001 releaser: Add release notes to /docs for release of 0.27.1 213c6c3b Add bugs poster 8b4590cd Add KeyCDN integration tutorial 2b277859 Add tutorial videos to several docs pages 950fef1f Update roadmap to link to the correct milestones page 496f5bf6 Rename relnotes d6f9378d Bump Netlify versions to 0.27 087fde7f Update 0.27 release notes 603f94ae docs: Document Related Content 3790f6a3 releaser: Bump versions for release of 0.27 0948868c releaser: Add release notes to /docs for release of 0.27 git-subtree-dir: docs git-subtree-split: 32356e4eabe357ae914f4d1d59e8ae31ce936723
75 lines
No EOL
2.3 KiB
Markdown
75 lines
No EOL
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]
|
||
keywords: [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/ |