Skip to main content
Version: 2.0.0-beta.16 🚧

πŸ“¦ plugin-sitemap

This plugin creates sitemaps for your site so that search engine crawlers can crawl your site more accurately.

production only

This plugin is always inactive in development and only active in production because it works on the build output.

Installation​

npm install --save @docusaurus/plugin-sitemap
tip

If you use the preset @docusaurus/preset-classic, you don't need to install this plugin as a dependency.

You can configure this plugin through the preset options.

Configuration​

Accepted fields:

NameTypeDefaultDescription
changefreqstring'weekly'See sitemap docs
prioritynumber0.5See sitemap docs
info

This plugin also respects some site config:

  • noIndex: results in no sitemap generated
  • trailingSlash: determines if the URLs in the sitemap have trailing slashes

Example configuration​

You can configure this plugin through preset options or plugin options.

tip

Most Docusaurus users configure this plugin through the preset options.

If you use a preset, configure this plugin through the preset options:

docusaurus.config.js
module.exports = {
presets: [
[
'@docusaurus/preset-classic',
{
sitemap: {
changefreq: 'weekly',
priority: 0.5,
},
},
],
],
};

You can find your sitemap at /sitemap.xml.