rsnext/examples/with-sitemap
Henrik Wenz 92aafcbcf1
[Docs] Add config types to all examples (#40083)
<!--
Thanks for opening a PR! Your contribution is much appreciated.
In order to make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below.
Choose the right checklist for the change that you're making:
-->

## Summary

- Added jsdoc typing for all examples using `next.config.js`
- Added jsdoc typing for all examples using `tailwind.config.js`

## Documentation / Examples

- [x] Make sure the linting passes by running `pnpm lint`
- [x] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)
2022-08-31 16:41:22 -05: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 Update default gitignore templates (#39051) 2022-07-26 20:08:40 -05:00
next.config.js [Docs] Add config types to all examples (#40083) 2022-08-31 16:41:22 -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(examples): improve DX while copying command to create new project (#38410) 2022-07-26 21:57:48 -05: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.

Deploy your own

Deploy the example using Vercel or preview live with StackBlitz

Deploy with Vercel

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