Sitemap

Automatic XML sitemap generation for SEO

sukr generates an XML sitemap at build time for search engine optimization.

Output

After building, you'll find sitemap.xml in your output directory:

public/
├── index.html
├── feed.xml
├── sitemap.xml  ← XML sitemap
└── blog/
    └── ...

Sitemap Contents

The sitemap includes URLs for:

  • Homepage (/index.html)
  • Section index pages (/blog/index.html, etc.)
  • All content items within sections
  • Standalone pages (top-level .md files)
  • Tag listing pages (/tags/<tag>.html), if any tags exist

Auto-generation

Sitemap generation happens automatically during every build. No configuration required.

URLs use the base_url from site.toml to construct absolute URLs as required by the sitemap protocol.

Disabling the Sitemap

To suppress sitemap generation, add to site.toml:

[sitemap]
enabled = false

The sitemap is enabled by default.

Last Modified Dates

If content has a date field in frontmatter, it's included as <lastmod>:

+++
title = "My Post"
date = 2024-01-15
+++

Content without dates omits the <lastmod> element.

Linking to the Sitemap

Add a link in your base.html template or robots.txt:

Sitemap: https://example.com/sitemap.xml

Validation

Test your sitemap with Google's Rich Results Test or the XML Sitemap Validator.