generateSitemap() — astro Function Reference

Architecture documentation for the generateSitemap() function in generate-sitemap.ts from the astro codebase.

Function typescript CoreAstro RoutingSystem calls 1

Entity Profile

CoreAstro→ RoutingSystem→ generateSitemap() — astro Function Reference

Dependency Diagram

graph TD
  9dbe89e5_a8f4_3c74_45b9_38a2b2e87101["generateSitemap()"]
  4d468d9c_03e7_8c51_0595_3a29c64d320e["generate-sitemap.ts"]
  9dbe89e5_a8f4_3c74_45b9_38a2b2e87101 -->|defined in| 4d468d9c_03e7_8c51_0595_3a29c64d320e
  cacf4540_2298_2ff0_86d4_04db3e32abba["createGetI18nLinks()"]
  9dbe89e5_a8f4_3c74_45b9_38a2b2e87101 -->|calls| cacf4540_2298_2ff0_86d4_04db3e32abba
  style 9dbe89e5_a8f4_3c74_45b9_38a2b2e87101 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/integrations/sitemap/src/generate-sitemap.ts lines 6–30

export function generateSitemap(pages: string[], finalSiteUrl: string, opts?: SitemapOptions) {
	const { changefreq, priority, lastmod: lastmodSrc, i18n } = opts ?? {};
	// TODO: find way to respect <link rel="canonical"> URLs here
	const urls = [...pages];
	urls.sort((a, b) => a.localeCompare(b, 'en', { numeric: true })); // sort alphabetically so sitemap is same each time

	const lastmod = lastmodSrc?.toISOString();

	// Parse URLs for i18n matching later
	const { defaultLocale, locales } = i18n ?? {};
	let getI18nLinks: GetI18nLinks | undefined;
	if (defaultLocale && locales) {
		getI18nLinks = createGetI18nLinks(urls, defaultLocale, locales, finalSiteUrl);
	}

	const urlData: SitemapItem[] = urls.map((url, i) => ({
		url,
		links: getI18nLinks?.(i),
		lastmod,
		priority,
		changefreq: changefreq as EnumChangefreq,
	}));

	return urlData;
}