站点地图生成

VitePress 内置支持为您的网站生成 sitemap.xml 文件。要启用它，请将以下内容添加到您的 .vitepress/config.js 中

import { defineConfig } from 'vitepress'

export default defineConfig({
  sitemap: {
    hostname: 'https://example.com'
  }
})

要使您的 sitemap.xml 中包含 <lastmod> 标签，您可以启用 lastUpdated 选项。

选项

站点地图支持由 sitemap 模块提供。您可以将它支持的任何选项传递给您的配置文件中的 sitemap 选项。这些选项将直接传递给 SitemapStream 构造函数。有关更多详细信息，请参阅 sitemap 文档。示例

import { defineConfig } from 'vitepress'

export default defineConfig({
  sitemap: {
    hostname: 'https://example.com',
    lastmodDateOnly: false
  }
})

transformItems 钩子

您可以在将站点地图项写入 sitemap.xml 文件之前使用 sitemap.transformItems 钩子修改它们。此钩子使用站点地图项数组调用，并期望返回一个站点地图项数组。示例

import { defineConfig } from 'vitepress'

export default defineConfig({
  sitemap: {
    hostname: 'https://example.com',
    transformItems: (items) => {
      // add new items or modify/filter existing items
      items.push({
        url: '/extra-page',
        changefreq: 'monthly',
        priority: 0.8
      })
      return items
    }
  }
})