📦 plugin-sitemap

这个插件会为你的站点创建一个站点地图，以便搜索引擎的爬虫能够更准确地爬取你的网站。

production only

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

Installation

npm

npm install --save @docusaurus/plugin-sitemap

Yarn

yarn add @docusaurus/plugin-sitemap

pnpm

pnpm add @docusaurus/plugin-sitemap

提示

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

接受的字段：

参数	类型	默认值	描述
changefreq	string	'weekly'	See sitemap docs
priority	number	0.5	See sitemap docs
ignorePatterns	string[]	[]	一列 glob 模式。匹配成功的路径不会出现在站点地图中。 注意你可能要在这里加上 base URL。
filename	string	sitemap.xml	创建的站点地图的路径，相对于输出目录。 如果你有两个插件实例输出两个文件，会很有用。

信息

这个插件会读取某些站点配置：

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

Example configuration

你可以通过预设选项或插件选项来配置这个插件。

提示

大多数 Docusaurus 用户通过预设选项配置此插件。

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,
          ignorePatterns: ['/tags/**'],
          filename: 'sitemap.xml',
        },
      },
    ],
  ],
};

Plugin options

If you are using a standalone plugin, provide options directly to the plugin:

docusaurus.config.js

module.exports = {
  plugins: [
    [
      '@docusaurus/plugin-sitemap',
      {
        changefreq: 'weekly',
        priority: 0.5,
        ignorePatterns: ['/tags/**'],
        filename: 'sitemap.xml',
      },
    ],
  ],
};

You can find your sitemap at /sitemap.xml.