サイトマップの生成

VitePress にはサイトの sitemap.xml ファイルを生成するためのすぐれたサポートが備わっています。これを有効にするには、.vitepress/config.js に次を追加します。

import { defineConfig } from 'vitepress'

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

<lastmod> タグを sitemap.xml に追加するには、lastUpdated オプションを有効にすることができます。

オプション

サイトマップのサポートは sitemap モジュールによって提供されています。構成ファイルの sitemap オプションに、これでサポートされる任意のオプションを渡せます。これらは SitemapStream コンストラクターに直接渡されます。詳細については、sitemap のドキュメント を参照してください。例

import { defineConfig } from 'vitepress'

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

transformItems フック

sitemap.transformItems フックを使用して、サイトマップ項目を sitemap.xml ファイルに書き込む前に修正できます。このフックはサイトマップ項目の配列を呼び出して、サイトマップ項目の配列を返すことを期待しています。例

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