close
Rspress
Guide
Plugin
API
Version
Guide
Plugin
API

@rspress/plugin-sitemap
Source

Automatically generate sitemap for SEO, which helps search engines crawl your site.

Installation

npm
yarn
pnpm
bun
npm add @rspress/plugin-sitemap -D

Usage

Add the following configuration in rspress.config.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', // Replace with your site URL
    }),
  ],
});

Configuration

This plugin accepts an object parameter with the following type:

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

  • Type: string
  • Required

The site URL for deployment access, for example https://example.com.

When there is a base configuration, siteUrl needs to include the base path. For example:

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

export default defineConfig({
  base: '/base/',
  plugins: [
    pluginSitemap({
      siteUrl: 'https://example.com/base/',
    }),
  ],
});

customMaps

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

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

Used to set custom sitemap values for certain important pages individually.

defaultChangeFreq

  • Type: ChangeFreq
  • Default: 'monthly'
  • Options: "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never"

changefreq: How frequently the page is likely to change. This value provides general information to search engines and may not correlate exactly to how often they crawl the page.

Sets the default changefreq value for each page in the generated sitemap file.

defaultPriority

  • Type: Priority
  • Default: '0.5'
  • Options: "0.0" | "0.1" | "0.2" | "0.3" | "0.4" | "0.5" | "0.6" | "0.7" | "0.8" | "0.9" | "1.0"

priority: The priority of this URL relative to other URLs on your site.

Sets the default priority value for each page in the generated sitemap file.