sitemap

Table of Contents

Installation

npm install --save sitemap

Generate a one time sitemap from a list of urls

npx sitemap< listofurls.txt# `npx sitemap -h` for more examples and a list of options.

const{ SitemapStream, streamToPromise}=require('sitemap')const{ Readable}=require('stream')// An array with your linksconstlinks=[{url:'/page-1/',changefreq:'daily',priority:0.3}]// Create a stream to write toconststream=newSitemapStream({hostname:'https://...'})// Return a promise that resolves with your XML stringreturnstreamToPromise(Readable.from(links).pipe(stream)).then((data)=>data.toString())

Serve a sitemap from a server and periodically update it

constexpress=require('express')const{ SitemapStream, streamToPromise}=require('sitemap')const{ createGzip}=require('zlib')const{ Readable}=require('stream')constapp=express()letsitemapapp.get('/sitemap.xml',function(req,res){res.header('Content-Type','application/xml');res.header('Content-Encoding','gzip');// if we have a cached entry send itif(sitemap){res.send(sitemap)return}try{constsmStream=newSitemapStream({hostname:'https://example.com/'})constpipeline=smStream.pipe(createGzip())// pipe your entries or directly write them.smStream.write({url:'/page-1/',changefreq:'daily',priority:0.3})smStream.write({url:'/page-2/',changefreq:'monthly',priority:0.7})smStream.write({url:'/page-3/'})// changefreq: 'weekly',  priority: 0.5smStream.write({url:'/page-4/',img:"http://urlTest.com"})/* or use    Readable.from([{url: '/page-1'}...]).pipe(smStream)    if you are looking to avoid writing your own loop.    */// cache the responsestreamToPromise(pipeline).then(sm=>sitemap=sm)// make sure to attach a write stream such as streamToPromise before endingsmStream.end()// stream write the responsepipeline.pipe(res).on('error',(e)=>{throwe})}catch(e){console.error(e)res.status(500).end()}})app.listen(3000,()=>{console.log('listening')});

Create sitemap and index files from one large list

const{ createReadStream, createWriteStream}=require('fs');const{ resolve}=require('path');const{ createGzip}=require('zlib')const{  simpleSitemapAndIndex,  lineSeparatedURLsToSitemapOptions}=require('sitemap')// writes sitemaps and index out to the destination you provide.simpleSitemapAndIndex({hostname:'https://example.com',destinationDir:'./',sourceData:lineSeparatedURLsToSitemapOptions(createReadStream('./your-data.json.txt')),// or (only works with node 10.17 and up)sourceData:[{url:'/page-1/',changefreq:'daily'}, ...],// orsourceData:'./your-data.json.txt',}).then(()=>{// Do follow up actions})

const{ createReadStream, createWriteStream}=require('fs');const{ resolve}=require('path');const{ createGzip}=require('zlib')const{ Readable}=require('stream')const{  SitemapAndIndexStream,  SitemapStream,  lineSeparatedURLsToSitemapOptions}=require('sitemap')constsms=newSitemapAndIndexStream({limit:50000,// defaults to 45klastmodDateOnly:false,// print date not time// SitemapAndIndexStream will call this user provided function every time// it needs to create a new sitemap file. You merely need to return a stream// for it to write the sitemap urls to and the expected url where that sitemap will be hostedgetSitemapStream:(i)=>{constsitemapStream=newSitemapStream({hostname:'https://example.com'});// if your server automatically serves sitemap.xml.gz when requesting sitemap.xml leave this line be// otherwise you will need to add .gz here and remove it a couple lines below so that both the index// and the actual file have a .gz extensionconstpath=`./sitemap-${i}.xml`;constws=sitemapStream.pipe(createGzip())// compress the output of the sitemap.pipe(createWriteStream(resolve(path+'.gz')));// write it to sitemap-NUMBER.xmlreturn[newURL(path,'https://example.com/subdir/').toString(),sitemapStream,ws];},});// when reading from a filelineSeparatedURLsToSitemapOptions(createReadStream('./your-data.json.txt')).pipe(sms).pipe(createGzip()).pipe(createWriteStream(resolve('./sitemap-index.xml.gz')));// or reading straight from an in-memory arraysms.pipe(createGzip()).pipe(createWriteStream(resolve('./sitemap-index.xml.gz')));constarrayOfSitemapItems=[{url:'/page-1/',changefreq:'daily'}, ...]Readable.from(arrayOfSitemapItems).pipe(sms)// available as of node 10.17.0// orarrayOfSitemapItems.forEach(item=>sms.write(item))sms.end()// necessary to let it know you've got nothing else to write

Options you can pass

const{ SitemapStream, streamToPromise}=require('sitemap');constsmStream=newSitemapStream({hostname:'http://www.mywebsite.com',xslUrl:"https://example.com/style.xsl",lastmodDateOnly:false,// print date not timexmlns:{// trim the xml namespacenews:true,// flip to false to omit the xml namespace for newsxhtml:true,image:true,video:true,custom:['xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd"','xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"',],}})// coalesce stream to value// alternatively you can pipe to another streamstreamToPromise(smStream).then(console.log)smStream.write({url:'/page1',changefreq:'weekly',priority:0.8,// A hint to the crawler that it should prioritize this over items less than 0.8})// each sitemap entry supports many options// See [Sitemap Item Options](./api.md#sitemap-item-options) below for detailssmStream.write({url:'http://test.com/page-1/',img:[{url:'http://test.com/img1.jpg',caption:'An image',title:'The Title of Image One',geoLocation:'London, United Kingdom',license:'https://creativecommons.org/licenses/by/4.0/'},{url:'http://test.com/img2.jpg',caption:'Another image',title:'The Title of Image Two',geoLocation:'London, United Kingdom',license:'https://creativecommons.org/licenses/by/4.0/'}],video:[{thumbnail_loc:'http://test.com/tmbn1.jpg',title:'A video title',description:'This is a video'},{thumbnail_loc:'http://test.com/tmbn2.jpg',title:'A video with an attribute',description:'This is another video','player_loc':'http://www.example.com/videoplayer.mp4?video=123','player_loc:autoplay':'ap=1','player_loc:allow_embed':'yes'}],links:[{lang:'en',url:'http://test.com/page-1/'},{lang:'ja',url:'http://test.com/page-1/ja/'}],androidLink:'android-app://com.company.test/page-1/',news:{publication:{name:'The Example Times',language:'en'},genres:'PressRelease, Blog',publication_date:'2008-12-23',title:'Companies A, B in Merger Talks',keywords:'business, merger, acquisition, A, B',stock_tickers:'NASDAQ:A, NASDAQ:B'}})// indicate there is nothing left to writesmStream.end()

Examples

API

Maintainers

License