> For AI agents: the complete documentation index is available at /rspress-russian/llms.txt, the full documentation bundle is available at /rspress-russian/llms-full.txt.

# @rspress/plugin-sitemap 

[Исходный код](https://github.com/web-infra-dev/rspress/tree/main/packages/plugin-sitemap)

Автоматически генерирует [sitemap](https://developers.google.com/search/docs/crawling-indexing/sitemaps/overview) для SEO, чтобы поисковые системы могли легче индексировать ваш сайт.

:::info

Начиная с 2.1.0 вместо него используйте настройку [`sitemap`](/rspress-russian/api/config/config-basic.md#sitemap).

:::

## Установка


```sh [npm]
npm add @rspress/plugin-sitemap -D
```

```sh [yarn]
yarn add @rspress/plugin-sitemap -D
```

```sh [pnpm]
pnpm add @rspress/plugin-sitemap -D
```

```sh [bun]
bun add @rspress/plugin-sitemap -D
```

```sh [deno]
deno add npm:@rspress/plugin-sitemap -D
```

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

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

```ts
// 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', // Замените на адрес своего сайта
    }),
  ],
});
```

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

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

```ts
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`](/rspress-russian/api/config/config-basic.md#siteorigin) + [`base`](/rspress-russian/api/config/config-basic.md#base), либо `base`, если `siteOrigin` не задан

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

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

Если в Rspress настроены параметры [`siteOrigin`](/rspress-russian/api/config/config-basic.md#siteorigin) и [`base`](/rspress-russian/api/config/config-basic.md#base), параметр `siteUrl` на уровне плагина можно не указывать. Полный URL формируется в следующем порядке: `siteOrigin + base + routePath`. Если не заданы ни `siteUrl` на уровне плагина, ни `siteOrigin`, плагин использует в качестве резервного варианта значение `base`. Это сохраняет существующее поведение с относительными путями, но не позволяет генерировать абсолютные URL в карте сайта.

```ts
// 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

- **Тип**:

```ts
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](https://www.sitemaps.org/protocol.html) по умолчанию для всех страниц в генерируемом 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](https://www.sitemaps.org/protocol.html) по умолчанию для всех страниц в генерируемом sitemap-файле.
