Table of contents

Getting started

Installation

yarn add next-sitemap

Create config file

/**@type {import('next-sitemap').IConfig} */module.exports={siteUrl:process.env.SITE_URL||'https://example.com',generateRobotsTxt:true,// (optional)// ...other options}

Building sitemaps

{"build":"next build","postbuild":"next-sitemap"}

Custom config file

{"build":"next build","postbuild":"next-sitemap --config awesome.config.js"}

Building sitemaps with pnpm

//.npmrcenable-pre-post-scripts=true

Index sitemaps (Optional)

Splitting large sitemap into multiple files

/**@type {import('next-sitemap').IConfig} */module.exports={siteUrl:'https://example.com',generateRobotsTxt:true,sitemapSize:7000,}

Configuration Options

Custom transformation function

/**@type {import('next-sitemap').IConfig} */module.exports={transform:async(config,path)=>{// custom function to ignore the pathif(customIgnoreFunction(path)){returnnull}// only create changefreq along with path// returning partial properties will result in generation of XML field with only returned values.if(customLimitedField(path)){// This returns `path` & `changefreq`. Hence it will result in the generation of XML field with `path` and  `changefreq` properties only.return{loc:path,// => this will be exported as http(s)://<config.siteUrl>/<path>changefreq:'weekly',}}// Use default transformation for all other casesreturn{loc:path,// => this will be exported as http(s)://<config.siteUrl>/<path>changefreq:config.changefreq,priority:config.priority,lastmod:config.autoLastmod ?newDate().toISOString() :undefined,alternateRefs:config.alternateRefs??[],}},}

Additional paths function

/**@type {import('next-sitemap').IConfig} */module.exports={additionalPaths:async(config)=>{constresult=[]// required value onlyresult.push({loc:'/additional-page-1'})// all possible valuesresult.push({loc:'/additional-page-2',changefreq:'yearly',priority:0.7,lastmod:newDate().toISOString(),// acts only on '/additional-page-2'alternateRefs:[{href:'https://es.example.com',hreflang:'es',},{href:'https://fr.example.com',hreflang:'fr',},],})// using transformation from the current configurationresult.push(awaitconfig.transform(config,'/additional-page-3'))returnresult},}

Google News, image and video sitemap

/**@type {import('next-sitemap').IConfig} */constconfig={transform:async(config,path)=>{return{loc:path,// => this will be exported as http(s)://<config.siteUrl>/<path>changefreq:config.changefreq,priority:config.priority,lastmod:config.autoLastmod ?newDate().toISOString() :undefined,images:[{loc:'https://example.com/image.jpg'}],news:{title:'Article 1',publicationName:'Google Scholar',publicationLanguage:'en',date:newDate(),},}},}exportdefaultconfig

Full configuration example

/**@type {import('next-sitemap').IConfig} */module.exports={siteUrl:'https://example.com',changefreq:'daily',priority:0.7,sitemapSize:5000,generateRobotsTxt:true,exclude:['/protected-page','/awesome/secret-page'],alternateRefs:[{href:'https://es.example.com',hreflang:'es',},{href:'https://fr.example.com',hreflang:'fr',},],// Default transformation functiontransform:async(config,path)=>{return{loc:path,// => this will be exported as http(s)://<config.siteUrl>/<path>changefreq:config.changefreq,priority:config.priority,lastmod:config.autoLastmod ?newDate().toISOString() :undefined,alternateRefs:config.alternateRefs??[],}},additionalPaths:async(config)=>[awaitconfig.transform(config,'/additional-page'),],robotsTxtOptions:{policies:[{userAgent:'*',allow:'/',},{userAgent:'test-bot',allow:['/path','/path-2'],},{userAgent:'black-listed-bot',disallow:['/sub-path-1','/path-2'],},],additionalSitemaps:['https://example.com/my-custom-sitemap-1.xml','https://example.com/my-custom-sitemap-2.xml','https://example.com/my-custom-sitemap-3.xml',],},}

# *User-agent:*Allow: /# test-botUser-agent: test-botAllow: /pathAllow: /path-2# black-listed-botUser-agent: black-listed-botDisallow: /sub-path-1Disallow: /path-2# HostHost: https://example.com# SitemapsSitemap: https://example.com/sitemap.xml # Index sitemapSitemap: https://example.com/my-custom-sitemap-1.xmlSitemap: https://example.com/my-custom-sitemap-2.xmlSitemap: https://example.com/my-custom-sitemap-3.xml

Generating dynamic/server-side sitemaps

Server side index-sitemaps (getServerSideSitemapIndex)

Exclude server index sitemap from robots.txt

// next-sitemap.config.js/**@type {import('next-sitemap').IConfig} */module.exports={siteUrl:'https://example.com',generateRobotsTxt:true,exclude:['/server-sitemap-index.xml'],// <= exclude hererobotsTxtOptions:{additionalSitemaps:['https://example.com/server-sitemap-index.xml',// <==== Add here],},}

server side sitemap (getServerSideSitemap)

// next-sitemap.config.js/**@type {import('next-sitemap').IConfig} */module.exports={siteUrl:'https://example.com',generateRobotsTxt:true,exclude:['/server-sitemap.xml'],// <= exclude hererobotsTxtOptions:{additionalSitemaps:['https://example.com/server-sitemap.xml',// <==== Add here],},}

Typescript JSDoc

/**@type {import('next-sitemap').IConfig} */module.exports={// YOUR CONFIG}

Contribution