Easily create XML sitemaps for your website.
Generates a sitemap by crawling your site. Uses streams to efficiently write the sitemap to your drive and runs asynchronously to avoid blocking the thread. Is cappable of creating multiple sitemaps if threshold is reached. Respects robots.txt and meta tags.
This module is available on npm.
$ npm install -S sitemap-generator
This module is running only with Node.js and is not meant to be used in the browser.
const SitemapGenerator = require('sitemap-generator');
// create generator
const generator = SitemapGenerator('http://example.com', {
stripQuerystring: false
});
// register event listeners
generator.on('done', () => {
// sitemaps created
});
// start the crawler
generator.start();The crawler will fetch all folder URL pages and file types parsed by Google. If present the robots.txt will be taken into account and possible rules are applied for each URL to consider if it should be added to the sitemap. Also the crawler will not fetch URL's from a page if the robots meta tag with the value nofollow is present and ignore them completely if noindex rule is present. The crawler is able to apply the base value to found links.
The generator offers straightforward methods to start and stop it. You can also add URL's manually.
Starts crawler asynchronously and writes sitemap to disk.
Stops the running crawler and halts the sitemap generation.
Returns the crawler instance. For more information about the crawler check the simplecrawler docs.
Add a URL to crawler's queue. Useful to help crawler fetch pages it can't find itself.
There are a couple of options to adjust the sitemap output. In addition to the options beneath the options of the used crawler can be changed. For a complete list please check it's official documentation.
var generator = SitemapGenerator('http://example.com', {
maxDepth: 0,
filepath: path.join(process.cwd(), 'sitemap.xml'),
maxEntriesPerFile: 50000,
stripQuerystring: true
});Type: string
Default: undefined
If defined, adds a <changefreq> line to each URL in the sitemap. Possible values are always, hourly, daily, weekly, monthly, yearly, never. All other values are ignored.
Type: string
Default: ./sitemap.xml
Filepath for the new sitemap. If multiple sitemaps are created "part_$index" is appended to each filename.
Type: HTTPAgent
Default: http.globalAgent
Controls what HTTP agent to use. This is useful if you want configure HTTP connection through a HTTP/HTTPS proxy (see http-proxy-agent).
Type: HTTPAgent
Default: https.globalAgent
Controls what HTTPS agent to use. This is useful if you want configure HTTPS connection through a HTTP/HTTPS proxy (see https-proxy-agent).
Type: boolean
Default: false
Whether to add a <lastmod> line to each URL in the sitemap, and fill it with today's date.
Type: number
Default: 50000
Google limits the maximum number of URLs in one sitemap to 50000. If this limit is reached the sitemap-generator creates another sitemap. A sitemap index file will be created as well.
Type: array
Default: []
If provided, adds a <priority> line to each URL in the sitemap. Each value in priorityMap array corresponds with the depth of the URL being added. For example, the priority value given to a URL equals priorityMap[depth - 1]. If a URL's depth is greater than the length of the priorityMap array, the last value in the array will be used. Valid values are between 1.0 and 0.0.
Type: string
Default: undefined
If provided, adds a basic Http authentication. Must be provided in the following format: user:pass.
The Sitemap Generator emits several events which can be listened to.
Triggered when the crawler successfully added a resource to the sitemap. Passes the url as argument.
generator.on('add', (url) => {
// log url
});Triggered when the crawler finished and the sitemap is created.
generator.on('done', () => {
// sitemaps created
});Thrown if there was an error while fetching an URL. Passes an object with the http status code, a message and the url as argument.
generator.on('error', (error) => {
console.log(error);
// => { code: 404, message: 'Not found.', url: 'http://example.com/foo' }
});If an URL matches a disallow rule in the robots.txt file or meta robots noindex is present this event is triggered. The URL will not be added to the sitemap. Passes the ignored url as argument.
generator.on('ignore', (url) => {
// log ignored url
});