mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
766085c2dc
81847981f Add notes for installing "extended" Sass/SCSS version 02da3bb58 Include usage of disqus internal template 9b53380c4 Update sitemap-template.md f3417dd52 Update sitemap-template.md aae33d9a8 Update sitemap-template.md 834edc205 Release 0.45.1 fb93ab905 Merge branch 'temp451' 79f350906 releaser: Prepare repository for 0.46-DEV 25cd2352c releaser: Add release notes to /docs for release of 0.45.1 e60377c71 releaser: Bump versions for release of 0.45.1 873f6dce2 Update features.md ecc116642 Update link for Azure cb88c3185 Added .Site.Home to Site Variiables (#541) 975a88791 Document includePaths 56c4e332f Release Hugo 0.45 c22b25210 Merge branch 'temp45' 0ffad3ada releaser: Prepare repository for 0.46-DEV 08d494cc3 releaser: Add release notes to /docs for release of 0.45 ad546ba45 releaser: Bump versions for release of 0.45 971c46bb2 Fixed "Sratch" to become "Scratch" on line 44 a28255bf3 Clarify the meaning of .Pages vs .Site.Pages 127aeee09 docs: Update ref, relref, GetPage docs 350d674ec resources.Concat doesn't have an alias 1fd1219b0 docs: Document refLinksErrorLevel and refLinksNotFoundURL af2252ff6 Merge commit 'a3535c8486b2ce762b1a8a9c30b03985c3e02cee' a11486805 Merge commit 'b6b37a1f00f808f3c0d2715f65ca2d3091f36495' 1c8896cb1 Fix addkit link to account for i18n 468aef3fc releaser: Prepare repository for 0.45-DEV c6f4b97a2 releaser: Add release notes to /docs for release of 0.44 d3985afb7 releaser: Bump versions for release of 0.44 2c59a330c Adjust release notes 83966769a releaser: Prepare repository for 0.44-DEV e539613f7 releaser: Add release notes to /docs for release of 0.43 2bf648944 releaser: Bump versions for release of 0.43 d9d6e4bf7 Fix typos d6798afda Merge commit '98293eaa1570b5aff4452021c8b6d6c8560b3f06' 37cc52261 Add a newScratch template func 1f7f09613 Merge branch 'release-0.42.2' 857b0b26a releaser: Prepare repository for 0.43-DEV git-subtree-dir: docs git-subtree-split: 81847981f1f2cb1ebc83d42d275a2afb2bb22df1
111 lines
3.4 KiB
Markdown
111 lines
3.4 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, templates]
|
||
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.
|
||
|
||
## Sitemap Templates
|
||
|
||
Hugo has built-on Sitemap templates, but you can provide your own if needed, in either `layouts/sitemap.xml` or `layouts/_default/sitemap.xml`.
|
||
|
||
For multilingual sites, we also create a Sitemap index. You can provide a custom layout for that in either `layouts/sitemapindex.xml` or `layouts/_default/sitemapindex.xml`.
|
||
|
||
## Hugo’s sitemap.xml
|
||
|
||
This template respects the version 0.9 of the [Sitemap Protocol](http://www.sitemaps.org/protocol.html).
|
||
|
||
```xml
|
||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
|
||
xmlns:xhtml="http://www.w3.org/1999/xhtml">
|
||
{{ 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 }}{{ if .IsTranslated }}{{ range .Translations }}
|
||
<xhtml:link
|
||
rel="alternate"
|
||
hreflang="{{ .Lang }}"
|
||
href="{{ .Permalink }}"
|
||
/>{{ end }}
|
||
<xhtml:link
|
||
rel="alternate"
|
||
hreflang="{{ .Lang }}"
|
||
href="{{ .Permalink }}"
|
||
/>{{ 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 %}}
|
||
|
||
## Hugo's sitemapindex.xml
|
||
|
||
This is used to create a Sitemap index in multilingual mode:
|
||
|
||
```xml
|
||
<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
|
||
{{ range . }}
|
||
<sitemap>
|
||
<loc>{{ .SitemapAbsURL }}</loc>
|
||
{{ if not .LastChange.IsZero }}
|
||
<lastmod>{{ .LastChange.Format "2006-01-02T15:04:05-07:00" | safeHTML }}</lastmod>
|
||
{{ end }}
|
||
</sitemap>
|
||
{{ end }}
|
||
</sitemapindex>
|
||
```
|
||
|
||
## Configure `sitemap.xml`
|
||
|
||
Defaults for `<changefreq>`, `<priority>` and `filename` values can be set in the site's config file, e.g.:
|
||
|
||
{{< code-toggle file="config" >}}
|
||
[sitemap]
|
||
changefreq = "monthly"
|
||
priority = 0.5
|
||
filename = "sitemap.xml"
|
||
{{</ code-toggle >}}
|
||
|
||
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/
|