generate-sitemap-webpack-plugin

Webpack plugin to generate a sitemap.

Getting Started

To begin, you'll need to install generate-sitemap-webpack-plugin:

npm install generate-sitemap-webpack-plugin --save-dev

yarn add -D generate-sitemap-webpack-plugin

pnpm add -D generate-sitemap-webpack-plugin

Then add the plugin to your webpack config. For example:

webpack.config.js

const SitemapPlugin = require('generate-sitemap-webpack-plugin');

module.exports = {
  plugins: [new SitemapPlugin({ baseURL: 'https://your.website' })],
};

sitemap.xml

<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <url>
    <loc>https://your.website/index.html</loc>
  </url>
</urlset>

Note

generate-sitemap-webpack-plugin is to use files that already exist in the source tree, as part of the build process.

Note

If you want to add custom locations for sitemap.xml, you can use urls options

Usage

The plugin's signature:

webpack.config.js

const SitemapPlugin = require('generate-sitemap-webpack-plugin');

module.exports = {
  plugins: [new SitemapPlugin({ baseURL, urls, emitted, chunk, options })],
};

baseURL
urls
emitted
chunk
options

`baseURL` (required)

Root URL of your site (e.g. https://your.website)

Type: string

`urls`

Optional array of locations on your site. These can be strings or you can provide object to customize each url.

Type:

type urls = Array<string | SitemapURL>;

type SitemapURL = {
  loc: string;
  lastmod?: string;
  priority?: number;
  changefreq?: Changefreq;
};

Note

If you provide the object in array, the following attributes may be set on each path object.

Name	Type	Default	Description
`loc` (required)	`string`	N/A	URL of the page (e.g. some/link). Sum of this value and baseURL must be less than 2,048 characters.
`lastmod`	`string`	`undefined`	The date of last modification of the page (e.g. 2023-12-08). This date should be in W3C Datetime format. This format allows you to omit the time portion, if desired, and use YYYY-MM-DD.
`priority`	`number`	`undefined`	The priority of this URL relative to other URLs on your site. Valid values range from 0.0 to 1.0.
`changefreq`	`string`	`undefined`	How frequently the page is likely to change. List of applicable values based on sitemaps.org: `always`, `hourly`, `daily`, `weekly`, `monthly`, `yearly`, `never`

`emitted`

Optional object to customize each url by webpack emitted assets. If you set to boolean true, the emitted all .html file being used

callback
pattern

`callback`

Callback function for use emitted asset filename

Type:

type callback = (
  location: string
) => Omit<SitemapURL, 'loc'> | undefined | null;

sitemapURL

Default: N/A

`pattern`

Specific pattern to filter the asset (e.g. .html), This can be string (glob pattern) or you can provide function instead of string pattern

Type:

type pattern = string | ((asset: string) => boolean) | undefined;

Default: **/*.html

Note

pattern use glob pattern to filter asset. For more information, follow the links below

Glob Pattern Reference | Visual Studio Code

Featrues | minimatch

`chunk`

Optional object to customize each url by webpack chunk. You can use auxiliary files to make sitemap include image

callback
img

`callback`

Callback function for use chunk

Type (Required) :

type callback = (
  name: string,
  hash: string
) => SitemapURL | string | undefined | null;

Default: N/A

`img`

Options for add image locations

Type: boolean

Default: true

Note

If you provide options.chunk.img = true each url automatically contains auxiliary files which image extension is matched imageExtList = [apng, avif, gif, jpg, jpeg, jfif, pjpeg, pjp, png, svg, webp, bmp, ico, cur, tif, tiff]

`options`

Optional object of configuration settings.

Name	Type	Default	Description
`filename`	`string`	`sitemap.xml`	Name of the sitemap file emitted to your build output
`format`	`boolean`	`false`	Settings for format sitemap file. You can provide formatting options for write file prettier
`gzip`	`boolean`	`true`	Generating a gzipped `.xml.gz` sitemap. You can provide false to skip generating a gzipped. By default, both xml files are generated
`lastmod`	`string` / `boolean`	`false`	The date for on all urls. Can be overridden by url-specific lastmod config. If value is true, the current date will be used for all urls.
`priority`	`number`	`undefined`	A to be set globally on all locations. Can be overridden by url-specific priorty config.0.
`changefreq`	`string`	`undefined`	A to be set globally on all locations. Can be overridden by url-specific changefreq config.

Examples

1. Complex Example

webpack.config.js

const path = require('path');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const SitemapPlugin = require('generate-sitemap-webpack-plugin');

const entries = ['index', 'help', 'ejs'];
const entry = {};
const views = [];
entries.forEach((name) => {
  entry[name] = path.resolve(__dirname, `src/js/${name}.js`);

  const htmlPlugin = new HtmlWebpackPlugin({
    chunks: [name],
    minify: false,
    filename: `${name}.${name.includes('ejs') ? 'ejs' : 'html'}`,
    template: path.resolve(__dirname, `src/views/${name}.ejs`),
  });

  views.push(htmlPlugin);
});

module.exports = {
  mode: 'production',
  entry: {
    index: path.resolve(__dirname, 'path/to/index.js')
    entry: path.resolve(__dirname, 'path/to/entry.js')
    ejs: path.resolve(__dirname, 'path/to/ejs.js')
  },
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'js/[name].js',
  },
  plugins: [
    new SitemapPlugin({
      baseURL: 'https://your.website',
      emitted: {
        callback: (location) => ({
          priority: location.includes('index') ? 1 : undefined,
          changefreq: 'yearly',
        }),
        pattern: `**/*.{html,ejs}`,
      },
      urls: [
        'first',
        { loc: 'second.html', lastmod: '2023-12-19', priority: 0.3 },
      ],
      options: {
        filename: 'my-sitemap.xml',
        format: true, // default: false
        gzip: true // default: true
        changefreq: 'monthly',
        lastmod: true,
        priority: 0.6,
      },
    }),
    new HtmlWebpackPlugin({
      chunks: ['index'],
      filename: 'index.html',
      template: path.resolve(__dirname, 'path/to/index.html'),
    }),
    new HtmlWebpackPlugin({
      chunks: ['entry'],
      filename: 'entry.html',
      template: path.resolve(__dirname, 'path/to/entry.html'),
    }),
    new HtmlWebpackPlugin({
      chunks: ['ejs'],
      filename: 'ejs.ejs',
      template: path.resolve(__dirname, 'path/to/ejs.html'),
    }),
  ],
};

my-sitemap.xml

<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <url>
    <loc>https://your.website/index.html</loc>
    <lastmod>2023-12-19T03:29:51.291Z</lastmod>
    <changefreq>yearly</changefreq>
    <priority>1</priority>
  </url>
  <url>
    <loc>https://your.website/first</loc>
    <lastmod>2023-12-19T03:29:51.291Z</lastmod>
    <changefreq>monthly</changefreq>
    <priority>0.6</priority>
  </url>
  <url>
    <loc>https://your.website/entry.html</loc>
    <lastmod>2023-12-19T03:29:51.291Z</lastmod>
    <changefreq>yearly</changefreq>
  </url>
  <url>
    <loc>https://your.website/ejs.ejs</loc>
    <lastmod>2023-12-19T03:29:51.291Z</lastmod>
    <changefreq>yearly</changefreq>
  </url>
  <url>
    <loc>https://your.website/second.html</loc>
    <lastmod>2023-12-19</lastmod>
    <changefreq>monthly</changefreq>
    <priority>0.3</priority>
  </url>
</urlset>

2. Split Example

webpack.config.js

const SitemapPlugin = require('generate-sitemap-webpack-plugin');

module.exports = {
  // Some webpack config
  ...,
  plugins: [
    new SitemapPlugin({
      baseURL: 'https://your.website',
      urls: Array.from({ length: 150000 }, (_, i) => ({
        loc: `${i}.html`,
        lastmod:
          i < 50000 ? `2023-12-19` : undefined,
      })),
      options: {
        format: true
      }
    }),
  ],
};

sitemap.xml

<?xml version="1" encoding="UTF-8"?>
<sitemapindex>
  <sitemap>
    <loc>https://your.website/sitemap1.xml</loc>
    <lastmod>2023-12-19</lastmod>
  </sitemap>
  <sitemap>
    <loc>https://your.website/sitemap2.xml</loc>
  </sitemap>
  <sitemap>
    <loc>https://your.website/sitemap3.xml</loc>
  </sitemap>
</sitemapindex>

sitemap1.xml

<?xml version="1" encoding="UTF-8"?>
<urlset>
  <url>
    <loc>https://your.website/0.html</loc>
    <lastmod>2023-12-19</lastmod>
  </url>
  <url>
    <loc>https://your.website/1.html</loc>
    <lastmod>2023-12-19</lastmod>
  </url>
  ... 49,998 items
</urlset>

3. Chunk Example

webpack.config.js

const SitemapPlugin = require('generate-sitemap-webpack-plugin');

module.exports = {
  // Some webpack config
  ...,
  entry: {
    index: 'path/to/index.js'
    skip: 'path/to/skip.js'
  },
  module: {
    rules: [
      {
        test: /\.(?:jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$/i,
        type: 'asset/resource',
        generator: {
          filename: 'assets/[name]-[hash][ext]',
        },
      },
    ],
  },
  plugins: [
    new SitemapPlugin({
      baseURL: 'https://your.website',
      chunk: {
        callback: (name) => (name === 'skip' ? null : name + '.html'),
      },
      emitted: false,
      options: {
        format: true,
      },
    }),
  ],
};

index.js

import Sample from 'path/to/asset/sample.png';
import Move from 'path/to/asset/move.gif';

... some scripts

sitemap.xml

<?xml version="1" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1">
  <url>
    <loc>https://your.website/index.html</loc>
    <image:image>
      <image:loc>https://your.website/assets/move-31d6cfe0d16ae931b73c.gif</image:loc>
    </image:image>
    <image:image>
      <image:loc>https://your.website/assets/sample-31d6cfe0d16ae931b73c.png</image:loc>
    </image:image>
  </url>
</urlset>

License

MIT

Name		Name	Last commit message	Last commit date
Latest commit History 35 Commits
.husky		.husky
src		src
test		test
types		types
.eslintignore		.eslintignore
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc.json		.prettierrc.json
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
README.md		README.md
babel.config.js		babel.config.js
commitlint.config.js		commitlint.config.js
jest.config.js		jest.config.js
lint-staged.config.js		lint-staged.config.js
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
tsconfig.json		tsconfig.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

generate-sitemap-webpack-plugin

Getting Started

Usage

`baseURL` (required)

`urls`

`emitted`

`callback`

`pattern`

`chunk`

`callback`

`img`

`options`

Examples

1. Complex Example

2. Split Example

3. Chunk Example

License

About

Releases 1

Languages

License

janghye0k/generate-sitemap-webpack-plugin

Folders and files

Latest commit

History

Repository files navigation

generate-sitemap-webpack-plugin

Getting Started

Usage

baseURL (required)

urls

emitted

callback

pattern

chunk

callback

img

options

Examples

1. Complex Example

2. Split Example

3. Chunk Example

License

About

Topics

Resources

License

Stars

Watchers

Forks

Releases 1

Languages

`baseURL` (required)

`urls`

`emitted`

`callback`

`pattern`

`chunk`

`callback`

`img`

`options`