rsnext/examples/with-sitemap
Manny Becerra 36eba95227
Fixes #33153: Updating cross-references from master to main + canary (#33198)
* copy cleanup in env. variables docs

* copy cleanup in fast refresh docs

* Supplements #33153 - updating existing cross-references to `master` branch to renamed default branch of `main`

* Supplements #33153 - updating existing cross-references to `master` branch to renamed default branch of `main`

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
2022-01-12 02:55:35 +01:00
..
pages Fixes #33153: Updating cross-references from master to main + canary (#33198) 2022-01-12 02:55:35 +01: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 Remove licence from all example/package.json that has them (#28007) 2021-08-14 10:48:39 -05:00
README.md docs: add 'Open in StackBlitz' buttons to various examples (#25853) 2021-06-08 20:45:02 +00:00

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.

Preview

Preview the example live on StackBlitz:

Open in StackBlitz

Deploy your own

Deploy the example using Vercel:

Deploy with 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).