📦 plugin-sitemap
这个插件会为你的站点创建一个站点地图,以便搜索引擎的爬虫能够更准确地爬取你的网站。
production only
这个插件在开发过程中始终不工作,只在生产环境中启用,因为它会在构建输出上工作。
安装流程
- npm
- Yarn
- pnpm
npm install --save @docusaurus/plugin-sitemap
yarn add @docusaurus/plugin-sitemap
pnpm add @docusaurus/plugin-sitemap
提示
如果你已经安装了 @docusaurus/preset-classic
,就不需要安装这个包了。
You can configure this plugin through the preset options.
配置
接受的字段:
参数 | 类型 | 默认值 | 描述 |
---|---|---|---|
lastmod | 'date' | 'datetime' | null | null | date is YYYY-MM-DD. datetime is a ISO 8601 datetime. null is disabled. See sitemap docs. |
changefreq | string | null | 'weekly' | 见站点地图文档 |
priority | number | null | 0.5 | 见站点地图文档 |
ignorePatterns | string[] | [] | 一列 glob 模式。匹配成功的路径不会出现在站点地图中。 注意你可能要在这里加上 base URL。 |
filename | string | sitemap.xml | 创建的站点地图的路径,相对于输出目录。 如果你有两个插件实例输出两个文件,会很有用。 |
信息
这个插件会读取某些站点配置:
noIndex
: results in no sitemap generatedtrailingSlash
: determines if the URLs in the sitemap have trailing slashes
About
lastmod
The lastmod
option will only output a sitemap <lastmod>
tag if plugins provide route metadata attributes sourceFilePath
and/or lastUpdatedAt
.
All the official content plugins provide the metadata for routes backed by a content file (Markdown, MDX or React page components), but it is possible third-party plugin authors do not provide this information, and the plugin will not be able to output a <lastmod>
tag for their routes.