跳至內容

網站地圖產生

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

在 MIT 授權下發布。