Sitemap

PAGE.Sitemap

config.SitemapConfig

Access to the Sitemap method on a Page object is restricted to sitemap templates.

Methods

ChangeFreq

(string) How frequently a page is likely to change. Valid values are always, hourly, daily, weekly, monthly, yearly, and never. Default is "" (change frequency omitted from rendered sitemap).

{{ .Sitemap.ChangeFreq }}

Priority

(float) The priority of a page relative to any other page on the site. Valid values range from 0.0 to 1.0. Default is -1 (priority omitted from rendered sitemap).

{{ .Sitemap.Priority }}

Example

With this site configuration:

sitemap:
  changeFreq: monthly

[sitemap]
  changeFreq = 'monthly'

{
   "sitemap": {
      "changeFreq": "monthly"
   }
}

And this content:

---
sitemap:
  changeFreq: hourly
title: News
---

+++
title = 'News'
[sitemap]
  changeFreq = 'hourly'
+++

{
   "sitemap": {
      "changeFreq": "hourly"
   },
   "title": "News"
}

And this simplistic sitemap template:

{{ printf "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>" | safeHTML }}
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
  xmlns:xhtml="http://www.w3.org/1999/xhtml">
  {{ range .Pages }}
    <url>
      <loc>{{ .Permalink }}</loc>
      {{ if not .Lastmod.IsZero }}
        <lastmod>{{ .Lastmod.Format "2006-01-02T15:04:05-07:00" | safeHTML }}</lastmod>
      {{ end }}
      {{ with .Sitemap.ChangeFreq }}
        <changefreq>{{ . }}</changefreq>
      {{ end }}
    </url>
  {{ end }}
</urlset>

The change frequency will be hourly for the news page, and monthly for other pages.