Skip to content
当前页导航

Sitemap 生成

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

ts
import { defineConfig } from 'vitepress'

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

如果您想在sitemap.xml中使用<lastmod>标签,您可以启用lastUpdated选项。

选项

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

ts
import { defineConfig } from 'vitepress'

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

transformItems 钩子

您可以使用sitemap.transformItems钩子在将项目写入sitemap.xml文件之前修改站点地图项目。该钩子将使用一个包含站点地图项目的数组进行调用,并期望返回一个包含站点地图项目的数组。示例:

ts
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
    }
  }
})

本文档由全栈行动派(qzxdp.cn)翻译并整理