History

Tom 266a4d33b1 fix deploy button (#20774 )		2021-01-05 11:42:23 -05:00
..
pages	Add Sitemap Example (#15047 )	2020-07-24 11:35:39 -05:00
public	Add Sitemap Example (#15047 )	2020-07-24 11:35:39 -05:00
scripts	Add Sitemap Example (#15047 )	2020-07-24 11:35:39 -05:00
.env	Add Sitemap Example (#15047 )	2020-07-24 11:35:39 -05:00
.gitignore	Add missing gitignore	2020-08-06 00:07:15 -04:00
next.config.js	Add Sitemap Example (#15047 )	2020-07-24 11:35:39 -05:00
package.json	Add Sitemap Example (#15047 )	2020-07-24 11:35:39 -05:00
README.md	fix deploy button (#20774 )	2021-01-05 11:42:23 -05:00

README.md

With Sitemap example

This example shows how to generate a sitemap.xml file based on the pages in your Next.js app. The sitemap will be generated and saved in the public directory after starting the development server or by making a build.

Deploy your own

Deploy the example using Vercel:

How to use

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

npx create-next-app --example with-sitemap with-sitemap-app
# or
yarn 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).