@sergeymyssak/nextjs-sitemap

Multiple sitemaps

If the number of urls is more than 50000, then several sitemaps will be automatically created. You can customize the number of urls using sitemapSize

Sitemap methods

generateSitemap: () => Promise<ISitemapWriterResultItem[]>;

Generate sitemap

regenerateSitemapIndex: (sitemapsNames: string[]) => void;

When there are multiple sitemaps, a sitemap index is generated. If we somehow changed our sitemaps externally, then you can use this function to update sitemap index

Sitemap options

domains (optional): IDomain[]

Domain list - same as in next.config.js.

exclude (optional): string[]

The exclude parameter is an array of glob patterns to exclude static routes / folders from the generated sitemap.

excludeExtensions (optional): string[]

Ignore files by extension.

Example:

excludeIndex (optional): boolean

Remove index from URL, directory will be ending with the slash. Defaults to true.

include (optional): string[]

Array of extra paths to include in the sitemap. If you want to add any route with dynamic parameters, you have to set an array of dynamic routes.

Example:

trailingSlash (optional): boolean

Add trailing slashes. Defaults to false.

nextConfigPath (optional): string

Use exportPathMap from next.config.js file.

pagesConfig (optional): IPagesConfig[]

Object configuration of priority and changefreq per route / folder.

Example:

pagesDirectory (required): string

The directory where there are Next.js pages.

targetDirectory (required): string

The path to the public folder.

sitemapUrl (optional): string

The url which will be specified in the sitemap index file.

sitemapSize (optional): number

Maximum number of url in one sitemap file. Defaults to 50000.

sitemapStylesheet (optional): ISitemapStylesheet[]

Array of style objects that will be applied to sitemap.

Example:

Useful information

• The value of the hreflang attribute identifies the language (in ISO 639-1 format) and optionally a region (in ISO 3166-1 Alpha 2 format) of an alternate URL.

• You can gzip your sitemap.xml. The .gz extension just means that it's been compressed (using gzip compression), so that it's smaller and served faster. Most search engine bots can read gzip'd compressed content.

  Look at code how you can generate sitemap.xml.gz

  // import zlib from 'zlib'; // import fs from 'fs'; // import { configureSitemap } from '@sergeymyssak/nextjs-sitemap'; const zlib = require('zlib'); const fs = require('fs'); const { configureSitemap } = require('@sergeymyssak/nextjs-sitemap'); async function getDynamicPaths() { const data = ['house', 'flower', 'table']; return data.map((item) => `/project/${item}`); } getDynamicPaths().then((paths) => { const Sitemap = configureSitemap({ domains: [{ domain: 'example.com', defaultLocale: 'en' }], include: paths, exclude: ['/project/*'], excludeIndex: true, pagesConfig: { '/project/*': { priority: '0.5', changefreq: 'daily', }, }, trailingSlash: true, targetDirectory: __dirname + '/public', pagesDirectory: __dirname + '/src/pages', }); Sitemap.generateSitemap().then(() => { const inp = fs.createReadStream('public/sitemap.xml'); const out = fs.createWriteStream('public/sitemap.xml.gz'); const gzip = zlib.createGzip(); inp.pipe(gzip).pipe(out); fs.unlink('public/sitemap.xml', () => console.log('Sitemap.xml has been deleted!'), ); console.log('Sitemap.xml.gz has been created!'); }); });