With Sitemap example

This example shows how to generate a sitemap.xml file based on the pages in your Next.js app.

Deploy your own

Deploy the example using Vercel or preview live with StackBlitz

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-sitemap with-sitemap-app

yarn create next-app --example with-sitemap with-sitemap-app

pnpm create next-app --example with-sitemap with-sitemap-app

Your app should be up and running on http://localhost:3000 and the sitemap should now be available in http://localhost:3000/sitemap.xml! If it doesn't work, post on GitHub discussions.

To change the website URL used by sitemap.xml, open the file .env and change the WEBSITE_URL environment variable:

# Used to add the domain to sitemap.xml, replace it with a real domain in production
WEBSITE_URL=https://my-domain.com

Deploy it to the cloud with Vercel (Documentation).