📦 插件-站点地图
此插件为您的网站创建站点地图,以便搜索引擎爬虫能够更准确地抓取您的网站。
production only
此插件在开发中始终处于非活动状态,仅在生产环境中激活,因为它作用于构建输出。
安装
- npm
- Yarn
- pnpm
npm install --save @docusaurus/plugin-sitemap
yarn add @docusaurus/plugin-sitemap
pnpm add @docusaurus/plugin-sitemap
tip
如果你使用预设的@docusaurus/preset-classic,你不需要将此插件作为依赖项安装。
你可以通过预设选项来配置此插件。
配置
接受的字段:
| Name | Type | Default | Description |
|---|---|---|---|
changefreq | string | 'weekly' | See sitemap docs |
priority | number | 0.5 | See sitemap docs |
ignorePatterns | string[] | [] | A list of glob patterns; matching route paths will be filtered from the sitemap. Note that you may need to include the base URL in here. |
filename | string | sitemap.xml | The path to the created sitemap file, relative to the output directory. Useful if you have two plugin instances outputting two files. |
info
此插件还遵循一些站点配置:
noIndex: 导致不生成站点地图trailingSlash: 确定站点地图中的URL是否带有尾部斜杠
示例配置
您可以通过预设选项或插件选项来配置此插件。
tip
大多数Docusaurus用户通过预设选项配置此插件。
- 预设选项
- 插件选项
如果您使用预设,请通过预设选项配置此插件:
docusaurus.config.js
module.exports = {
presets: [
[
'@docusaurus/preset-classic',
{
sitemap: {
changefreq: 'weekly',
priority: 0.5,
ignorePatterns: ['/tags/**'],
filename: 'sitemap.xml',
},
},
],
],
};
如果您使用的是独立插件,请直接将选项提供给插件:
docusaurus.config.js
module.exports = {
plugins: [
[
'@docusaurus/plugin-sitemap',
{
changefreq: 'weekly',
priority: 0.5,
ignorePatterns: ['/tags/**'],
filename: 'sitemap.xml',
},
],
],
};
您可以在/sitemap.xml找到您的网站地图。