rsnext/examples/with-sitemap
Dominic Elm d2caaeab64
docs: add 'Open in StackBlitz' buttons to various examples (#25853)
This PR adds a `Preview` section and a `Open in StackBlitz` button to various examples. I have tested all examples and omitted the ones that require third party API keys, or didn't work. Some examples don't work locally either.

Here's an example:
![image](https://user-images.githubusercontent.com/12571019/121027783-88971280-c7a7-11eb-851a-0ad30cf74b42.png)

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Documentation added
- [x] Examples updated
- [ ] Telemetry added. In case of a feature if it's used or not.

## Documentation / Examples

- [x] Make sure the linting passes
2021-06-08 20:45:02 +00:00
..
pages Fix deploy buttons URLs (#20834) 2021-01-07 01:40:29 +00: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 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).