rsnext/examples/with-sitemap
leung018 66597be8a7
Add .yarn/install-state.gz to .gitignore (#56637)
### Reason for making this change
https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again.
In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited.

### Remaining work
I apologize for only modifying one template initially to initiate the discussion first.

If this change is agreed upon,  it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change.
2023-10-18 16:34:48 +00:00
..
pages Open deploy link in new window for examples (#40804) 2022-09-22 09:33:36 -07: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 .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +00:00
next.config.js [Docs] Add config types to all examples (#40083) 2022-08-31 16:41:22 -05:00
package.json Update Examples to use React 18 (#42027) 2022-10-28 17:43:20 +00:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04: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).