Генерация Sitemap

VitePress поддерживает генерацию файла sitemap.xml для вашего сайта "из коробки". Чтобы включить эту функцию, добавьте следующее в ваш файл .vitepress/config.js:

import { defineConfig } from 'vitepress'

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

Чтобы добавить теги <lastmod> в ваш sitemap.xml, вы можете включить опцию lastUpdated.

Опции

Поддержка sitemap работает на основе модуля sitemap. Вы можете передать любые поддерживаемые им опции в опцию sitemap вашего конфигурационного файла. Эти опции будут напрямую переданы конструктору SitemapStream. Смотрите документацию sitemap для получения более подробной информации. Пример:

import { defineConfig } from 'vitepress'

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

Хук transformItems

Вы можете использовать хук sitemap.transformItems для модификации элементов sitemap перед их записью в файл sitemap.xml. Этот хук вызывается с массивом элементов sitemap и ожидает возврата массива элементов sitemap. Пример:

import { defineConfig } from 'vitepress'

export default defineConfig({
  sitemap: {
    hostname: 'https://example.com',
    transformItems: (items) => {
      // добавление новых элементов или модификация/фильтрация существующих элементов
      items.push({
        url: '/extra-page',
        changefreq: 'monthly',
        priority: 0.8
      })
      return items
    }
  }
})