Table of Contents
sitemap-core
Note: The options API is still evolving; expect tweaks as the project grows.
What it does
- Generates a sitemap at
/sitemap.xmlvia a virtual template (enabled by default). - Adds
eleventyComputed.page.sitemapwith defaults so you can control per-page inclusion.
Defaults
- Template enabled: yes (
/sitemap.xml). page.sitemapdefaults:{ ignore: noindex ?? page.noindex ?? site.noindex ?? false, changefreq: "", priority: -1 }.- Excludes pages if
site.noindexis true, or ifeleventyExcludeFromCollectionsis set, or ifpage.sitemap.ignoreis true. lastmodusespage.data.sitemap.lastmodoritem.dateif present, formatted via thedate.toUTCISOglobal.layout: nullfor the sitemap template; excluded from collections.
Options
enableSitemapTemplate(boolean): toggle the built-in sitemap template (default:true).
How it works
- Registers
eleventyComputed.page.sitemapto give every page sitemap defaults. - If sitemap template is enabled, registers:
- A single sitemap at
/sitemap.xmlif site is in one language.
- A single sitemap at
- If multilingual and languages are supplied:
- A sitemap for each language in the root of each language (
/en/sitemap.xml). - A sitemap index at
/sitemap.xml.
- A sitemap for each language in the root of each language (
- Each sitemap loops
collections.all, filters out excluded items, and emits a<urlset>withloc, optionallastmod, optionalchangefreq, optionalpriority, andxhtml:linkalternates when translations exist.
Tips
- Set
site.noindex = trueto suppress the sitemap entirely. - On a page, set
sitemap: { ignore: true }to skip it, or setchangefreq/priorityto include those fields. - Provide
sitemap.lastmod(a date) to emit<lastmod>; otherwiseitem.dateis used when available. - For multilingual sites, supply
languages(object) andmultilingual: truein Baseline options to emit per-language sitemaps and a sitemap index with alternates. - Per-page
noindex: true(front matter) is respected by sitemap-core; usesitemap.ignoreoreleventyExcludeFromCollectionsfor explicit sitemap-only exclusion. - See the “Sitemaps & Drafts” tutorial for end-to-end usage.
- Tutorial: Sitemaps & Drafts
Previous: navigator-core