#@rspress/plugin-sitemap

Исходный код

Автоматически генерирует sitemap для SEO, чтобы поисковые системы могли легче индексировать ваш сайт.

#Установка

npm add @rspress/plugin-sitemap -D

yarn add @rspress/plugin-sitemap -D

pnpm add @rspress/plugin-sitemap -D

bun add @rspress/plugin-sitemap -D

deno add npm:@rspress/plugin-sitemap -D

#Использование

Добавьте следующую конфигурацию:

// rspress.config.ts
import path from 'path';
import { defineConfig } from '@rspress/core';
import { pluginSitemap } from '@rspress/plugin-sitemap';

export default defineConfig({
  plugins: [
    pluginSitemap({
      siteUrl: 'https://example.com', // Замените на адрес своего сайта
    }),
  ],
});

#Конфигурация

Плагин принимает объект параметров следующего типа:

type ChangeFreq =
  'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never';

type Priority =
  | '0.0'
  | '0.1'
  | '0.2'
  | '0.3'
  | '0.4'
  | '0.5'
  | '0.6'
  | '0.7'
  | '0.8'
  | '0.9'
  | '1.0';

// https://www.sitemaps.org/protocol.html
interface Sitemap {
  loc: string;
  lastmod?: string;
  changefreq?: ChangeFreq;
  priority?: Priority;
}

interface CustomMaps {
  [routePath: string]: Sitemap;
}

export interface PluginSitemapOptions {
  siteUrl?: string;
  customMaps?: CustomMaps;
  defaultPriority?: Priority;
  defaultChangeFreq?: ChangeFreq;
}

#siteUrl

• Тип: string
• По умолчанию: siteOrigin + base, либо base, если siteOrigin не задан

URL сайта, на котором будет развёрнута документация, например https://example.com.

Элементы <loc> в карте сайта должны содержать абсолютные URL с протоколом и доменом, например https://example.com/base/. Если задан параметр base, значение siteUrl на уровне плагина должно включать путь base.

Если в Rspress настроены параметры siteOrigin и base, параметр siteUrl на уровне плагина можно не указывать. Полный URL формируется в следующем порядке: siteOrigin + base + routePath. Если не заданы ни siteUrl на уровне плагина, ни siteOrigin, плагин использует в качестве резервного варианта значение base. Это сохраняет существующее поведение с относительными путями, но не позволяет генерировать абсолютные URL в карте сайта.

// rspress.config.ts
import path from 'path';
import { defineConfig } from '@rspress/core';
import { pluginSitemap } from '@rspress/plugin-sitemap';

export default defineConfig({
  siteOrigin: 'https://example.com',
  base: '/base/',
  plugins: [
    // По умолчанию `siteUrl` имеет значение `https://example.com/base/`
    pluginSitemap(),
  ],
});

#customMaps

• Тип:

interface Sitemap {
  loc: string;
  lastmod?: string;
  changefreq?: ChangeFreq;
  priority?: Priority;
}

interface CustomMaps {
  [routePath: string]: Sitemap;
}

• По умолчанию: {}

Задаёт пользовательские значения sitemap для отдельных важных страниц.

#defaultChangeFreq

• Тип: ChangeFreq
• По умолчанию: 'monthly'
• Возможные значения: "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never"

changefreq — как часто страница, вероятно, будет изменяться. Это значение даёт общую информацию поисковым системам и не обязательно точно соответствует частоте обхода страницы.

Задаёт значение changefreq по умолчанию для всех страниц в генерируемом sitemap-файле.

#defaultPriority

• Тип: Priority
• По умолчанию: '0.5'
• Возможные значения: "0.0" | "0.1" | "0.2" | "0.3" | "0.4" | "0.5" | "0.6" | "0.7" | "0.8" | "0.9" | "1.0"

priority — приоритет этой страницы относительно других страниц вашего сайта.

Задаёт значение priority по умолчанию для всех страниц в генерируемом sitemap-файле.