sitemap

为你的站点生成网站地图。

使用

npm i -D @vuepress/plugin-sitemap@next

import { sitemapPlugin } from '@vuepress/plugin-sitemap'

export default {
  plugins: [
    sitemapPlugin({
      hostname: 'https://example.com',
    }),
  ],
}

hostname 选项是必须的，网站地图的链接由它生成。

插件会使用来自 @vuepress/plugin-git 的最后更新时间，并根据多语言配置声明每个页面的其他语言版本地址。

链接控制

默认情况下，除 404 页面外站点的所有链接都会被包含在网站地图中。

• 使用 extraUrls 选项包含非 VuePress 生成的页面，通常是 public 目录下的文件；
• 使用 excludePaths 选项，或将页面的 sitemap Frontmatter 设置为 false，来排除页面。

更新周期

页面默认的更新周期为 daily，可以通过 changefreq 选项修改，也可以通过页面的 sitemap.changefreq Frontmatter 单独设置。

合法的周期为 always、hourly、daily、weekly、monthly、yearly 与 never。

修改时间

modifyTimeGetter 选项以 ISO 字符串格式返回页面的最后修改时间，默认来自 @vuepress/plugin-git。

// 基于文件的最后修改时间
;({
  modifyTimeGetter: (page, app) =>
    fs.statSync(app.dir.source(page.filePathRelative)).mtime.toISOString(),
})

robots.txt

网站地图会被搜索引擎读取，因此你应当在 .vuepress/public 目录下提供有效的 robots.txt 以允许爬虫访问。最简单的写法为：

User-agent: *

Allow: /

选项

Frontmatter

相关

• Sitemaps 协议