rsnext/examples/with-next-sitemap
Steven 9f9214abe5
Updated create-next-app docs to include pnpm usage (#35755)
This PR updates the docs and examples for `create-next-app` to include pnpm usage.

The following script was used to update every example README:

```js
const fs = require('fs')
const examples = fs.readdirSync('./examples')

for (let example of examples) {
    const filename = `./examples/${example}/README.md`
    const markdown = fs.readFileSync(filename, 'utf8')
    const regex = new RegExp(`^yarn create next-app --example (.*)$`, 'gm')
    const output = markdown.replace(regex, (yarn, group) => {
        const pnpm = `pnpm create next-app -- --example ${group}`
        return `${yarn}\n# or\n${pnpm}`
    })
    fs.writeFileSync(filename, output)
}
```
2022-03-30 21:03:21 +00:00
..
pages Added next-sitemap example (#15997) 2020-08-18 00:16:42 -04:00
.gitignore Add missing gitignore files 2020-08-29 21:55:58 -04:00
next-env.d.ts Include submodules in exported type definition (#28316) 2021-11-26 14:46:56 +01:00
next-sitemap.js Added next-sitemap example (#15997) 2020-08-18 00:16:42 -04:00
package.json Clean up examples package.json (#27121) 2021-07-12 19:58:03 +00:00
README.md Updated create-next-app docs to include pnpm usage (#35755) 2022-03-30 21:03:21 +00:00
tsconfig.json Added next-sitemap example (#15997) 2020-08-18 00:16:42 -04:00

next-sitemap example

This example uses next-sitemap to generate a sitemap file for all pages (including all pre-rendered/static pages).

next-sitemap allows the generation of sitemaps along with robots.txt and provides the feature to split large sitemaps into multiple files. Checkout the next-sitemap documentation to learn more.

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 or Yarn to bootstrap the example:

npx create-next-app --example with-next-sitemap with-next-sitemap-app
# or
yarn create next-app --example with-next-sitemap with-next-sitemap-app
# or
pnpm create next-app -- --example with-next-sitemap with-next-sitemap-app

Deploy it to the cloud with Vercel (Documentation).