Sitemap generation in Astro

Introduction

A sitemap helps search engines find and understand all pages on your website easily.

You want search engines like Google to index your site better.

Your website has many pages that need to be discovered quickly.

You update your site often and want search engines to know about new pages.

You want to improve your website's SEO by providing a clear page list.

Syntax

Astro

import { Sitemap } from 'astro:sitemap';

export async function GET() {
  return new Response(await Sitemap({
    filter: (page) => !page.includes('private'),
    changefreq: 'daily',
    priority: 0.7
  }));
}

The Sitemap function generates the sitemap XML automatically.

You can customize which pages to include and how often they change.

Examples

Generates a sitemap with default settings including all pages.

Astro

import { Sitemap } from 'astro:sitemap';

export async function GET() {
  return new Response(await Sitemap());
}

Generates a sitemap excluding pages with 'draft' in their path, sets update frequency to weekly, and priority to 0.5.

Astro

import { Sitemap } from 'astro:sitemap';

export async function GET() {
  return new Response(await Sitemap({
    filter: (page) => !page.includes('draft'),
    changefreq: 'weekly',
    priority: 0.5
  }));
}

Sample Program

This example creates a sitemap that excludes pages containing 'secret' in their URL. It sets the change frequency to monthly and priority to 0.8 to tell search engines how important and often pages change.

Astro

import { Sitemap } from 'astro:sitemap';

export async function GET() {
  return new Response(await Sitemap({
    filter: (page) => !page.includes('secret'),
    changefreq: 'monthly',
    priority: 0.8
  }));
}

Important Notes

Make sure your sitemap URL is listed in your robots.txt file for better search engine discovery.

Update your sitemap whenever you add or remove pages to keep search engines informed.

Summary

Sitemaps help search engines find all your website pages.

Astro provides a simple Sitemap function to generate sitemaps automatically.

You can customize which pages to include and how often they change.

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