Sitemap generation in Astro - Step-by-Step Execution

Concept Flow - Sitemap generation

Start Build Process

↓

Collect All Routes

↓

Format Routes as XML Entries

↓

Create sitemap.xml File

↓

Write sitemap.xml to Output Folder

↓

Build Complete

The sitemap generation process collects all site routes, formats them into XML, writes the sitemap file, and completes the build.

Execution Sample

Astro

import { Sitemap } from 'astro-sitemap';

export const prerender = true;

export async function GET() {
  return Sitemap.generate();
}

This code triggers sitemap generation by collecting routes and creating sitemap.xml during build.

Execution Table

Step	Action	Input/State	Output/Result
1	Start Build	No sitemap file	Begin collecting routes
2	Collect Routes	Site pages: /, /about, /blog	List of URLs collected
3	Format XML	List of URLs	<urlset> XML entries created
4	Create File	XML content	sitemap.xml file created in output
5	Write File	sitemap.xml content	File saved to dist folder
6	Build Complete	sitemap.xml saved	Build process ends with sitemap ready

💡 All site routes processed and sitemap.xml file generated successfully

Variable Tracker

Variable	Start	After Step 2	After Step 3	After Step 4	Final
routes	[]	["/", "/about", "/blog"]	["/", "/about", "/blog"]	["/", "/about", "/blog"]	["/", "/about", "/blog"]
xmlContent	""	""	"<urlset>...</urlset>"	"<urlset>...</urlset>"	"<urlset>...</urlset>"
sitemapFile	null	null	null	File object created	File saved to disk

Key Moments - 3 Insights

Why do we need to collect all routes before creating the sitemap file?

Because the sitemap file lists all URLs, so we must gather every route first (see Step 2 in execution_table).

What format does the sitemap use to list URLs?

It uses XML format with <urlset> tags to organize URLs (see Step 3 in execution_table).

When is the sitemap.xml file actually created and saved?

After formatting XML content, the file is created and then saved to the output folder (see Steps 4 and 5).

Visual Quiz - 3 Questions

Look at the execution_table, what is the state of 'routes' after Step 2?

A ["/", "/about", "/blog"]

B []

C ["/contact"]

D null

💡 Hint

Check the variable_tracker row for 'routes' after Step 2

At which step is the sitemap.xml file created?

A Step 2

B Step 3

C Step 4

D Step 5

💡 Hint

Look at the 'Action' column in execution_table for file creation

If a new page '/contact' is added, how would the 'routes' variable change after Step 2?

A ["/", "/about", "/blog"]

B ["/", "/about", "/blog", "/contact"]

C []

D null

💡 Hint

Refer to variable_tracker for 'routes' and imagine adding one more URL

Concept Snapshot

Sitemap generation in Astro:
- Collect all site routes during build
- Format routes as XML <urlset> entries
- Create sitemap.xml file with XML content
- Save sitemap.xml to output folder
- Enables search engines to find all pages
- Triggered via integration or API route

Full Transcript

Sitemap generation in Astro starts with the build process collecting all site routes like '/', '/about', and '/blog'. These routes are formatted into XML entries inside a <urlset> tag. Then, a sitemap.xml file is created with this XML content and saved to the output folder. This file helps search engines discover all pages on the site. The process completes when the sitemap.xml is successfully saved. Variables like 'routes' hold the list of URLs, 'xmlContent' holds the XML string, and 'sitemapFile' represents the file created and saved. Key moments include understanding why all routes must be collected first, recognizing the XML format used, and knowing when the file is created and saved.

Practice

1. What is the main purpose of generating a sitemap in an Astro project?

easy

A. To speed up the website's loading time

B. To improve the website's visual design

C. To help search engines find and index all pages of the website

D. To add interactive animations to the site

Solution

1. Step 1: Understand sitemap purpose

   Sitemaps list all pages so search engines can find them easily.

2. Step 2: Match purpose to options

   Only To help search engines find and index all pages of the website describes helping search engines find pages.

3. Final Answer:

   To help search engines find and index all pages of the website -> Option C

4. Quick Check:

   Sitemap purpose = Help search engines [OK]

Hint: Sitemaps guide search engines to your pages [OK]

Common Mistakes:

• Confusing sitemap with design or speed improvements
• Thinking sitemap adds animations
• Assuming sitemap affects page loading

2. Which of the following is the correct way to import the Sitemap function in an Astro project?

easy

A. import { Sitemap } from 'astro/sitemap';

B. import Sitemap from 'astro/sitemap';

C. import { sitemap } from 'astro';

D. import * as Sitemap from 'astro/sitemap';

Solution

1. Step 1: Recall correct import syntax

   Astro exports Sitemap as a named export, so curly braces are needed.

2. Step 2: Match syntax to options

   import { Sitemap } from 'astro/sitemap'; uses named import with correct path and casing.

3. Final Answer:

   import { Sitemap } from 'astro/sitemap'; -> Option A

4. Quick Check:

   Named import with braces = import { Sitemap } from 'astro/sitemap'; [OK]

Hint: Use curly braces for named imports in Astro [OK]

Common Mistakes:

• Using default import syntax for named exports
• Incorrect module path or casing
• Importing with wrong variable name

3. Given this Astro sitemap configuration snippet:

export const get = () => {
  return Sitemap({
    filter: (page) => !page.includes('/drafts/'),
    changefreq: 'weekly'
  });
};

What will be the effect of the filter function?

medium

A. Exclude pages that have '/drafts/' in their path

B. Include all pages regardless of path

C. Include only pages that have '/drafts/' in their path

D. Cause a syntax error due to incorrect filter usage

Solution

1. Step 1: Understand the filter function logic

   The filter returns true only if the page path does NOT include '/drafts/'.

2. Step 2: Determine which pages are included

   Pages with '/drafts/' are excluded because filter returns false for them.

3. Final Answer:

   Exclude pages that have '/drafts/' in their path -> Option A

4. Quick Check:

   Filter excludes '/drafts/' pages = Exclude pages that have '/drafts/' in their path [OK]

Hint: Filter returns true to keep pages, false to exclude [OK]

Common Mistakes:

• Thinking filter includes '/drafts/' pages
• Confusing filter logic with map or reduce
• Assuming syntax error without checking code

4. Identify the error in this Astro sitemap generation code:

export const get = () => {
  return Sitemap({
    changefreq: 'daily',
    filter: page => page.startsWith('/blog')
  });
};

medium

A. Missing async keyword in get function

B. Sitemap function requires an array, not an object

C. Filter function should return a boolean but returns undefined

D. No error; code is correct

Solution

1. Step 1: Check get function signature

   Astro allows get to be sync or async; sync is valid here.

2. Step 2: Verify Sitemap usage

   Sitemap accepts an object with changefreq and filter keys as shown.

3. Step 3: Confirm filter function returns boolean

   page.startsWith('/blog') returns true or false, so filter is valid.

4. Final Answer:

   No error; code is correct -> Option D

5. Quick Check:

   Code syntax and logic are correct = No error; code is correct [OK]

Hint: Check return types and function signatures carefully [OK]

Common Mistakes:

• Assuming async is always required for get
• Thinking Sitemap needs an array argument
• Misunderstanding filter return value

5. You want to generate a sitemap in Astro that excludes pages with empty paths or falsy values and sets changefreq to 'monthly'. Which code snippet correctly achieves this?

hard

A. export const get = () => Sitemap({ filter: page => page, changefreq: 'monthly' });

B. export const get = () => Sitemap({ filter: page => !!page, changefreq: 'monthly' });

C. export const get = () => Sitemap({ filter: page => page === '', changefreq: 'monthly' });

D. export const get = () => Sitemap({ filter: page => page.length > 0, changefreq: 'monthly' });

Solution

1. Step 1: Understand filtering falsy values

   Using !!page converts page to boolean, excluding falsy values like empty strings.

2. Step 2: Check other options

   export const get = () => Sitemap({ filter: page => page, changefreq: 'monthly' }); returns page directly, which may include falsy values; export const get = () => Sitemap({ filter: page => page.length > 0, changefreq: 'monthly' }); assumes page has length property which may cause errors if undefined; export const get = () => Sitemap({ filter: page => page === '', changefreq: 'monthly' }); includes only empty strings, which is opposite of desired filtering; export const get = () => Sitemap({ filter: page => !!page, changefreq: 'monthly' }); correctly filters out falsy values.

3. Final Answer:

   export const get = () => Sitemap({ filter: page => !!page, changefreq: 'monthly' }); -> Option B

4. Quick Check:

   Double negation filters falsy values = export const get = () => Sitemap({ filter: page => !!page, changefreq: 'monthly' }); [OK]

Hint: Use !! to convert values to true/false for filtering [OK]

Common Mistakes:

• Using filter that includes empty strings
• Not converting to boolean before filtering
• Assuming page.length works if page can be undefined