mirror of
https://github.com/gohugoio/hugo.git
synced 2025-01-08 19:41:10 +00:00
76 lines
2.5 KiB
Markdown
76 lines
2.5 KiB
Markdown
|
---
|
|||
|
|
aliases:
|
|||
|
|
- /layout/sitemap/
|
|||
|
|
lastmod: 2015-12-10
|
|||
|
|
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`.**
|
|||
|
|
|
|||
|
|
A sitemap is a `Page` and have all the [page
|
|||
|
|
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>
|
|||
|
|
**.Sitemap.Filename** The sitemap filename<br>
|
|||
|
|
|
|||
|
|
If provided, Hugo will use `/layouts/sitemap.xml` instead of the internal
|
|||
|
|
one.
|
|||
|
|
|
|||
|
|
## Hugo’s sitemap.xml
|
|||
|
|
|
|||
|
|
This template uses the version 0.9 of the [Sitemap
|
|||
|
|
Protocol](http://www.sitemaps.org/protocol.html) with Google's [hreflang
|
|||
|
|
attributes](https://support.google.com/webmasters/answer/2620865?hl=en&topic=2370587&ctx=topic)
|
|||
|
|
for linking to translated content.
|
|||
|
|
|
|||
|
|
<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>
|
|||
|
|
|
|||
|
|
***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" ?>
|
|||
|
|
|
|||
|
|
## Configuring 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 page's front matter in order to override the value for that page.
|