close
Rspress
  • English

      • @rspress/plugin-sitemap
      Source Code

      Automatically generate a sitemap for SEO so search engines can crawl your site more easily.

      Installation

      npm
      yarn
      pnpm
      bun
      deno
      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 options object 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 base is configured, siteUrl must 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: {}

      Sets custom sitemap values for specific important pages.

      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.