Interface SitemapPluginOptions

Plugin congiguration.

interface SitemapPluginOptions {
    baseUrl: string;
    changeFreq?:
        | "always"
        | "never"
        | "hourly"
        | "daily"
        | "weekly"
        | "monthly"
        | "yearly";
    filename?: string;
    priority?: number;
}

Properties

baseUrl changeFreq? filename? priority?

Properties

baseUrl

baseUrl: string

The base URL of the documentation site (e.g., https://yourdomain.com/docs)

OptionalchangeFreq

changeFreq?:
    | "always"
    | "never"
    | "hourly"
    | "daily"
    | "weekly"
    | "monthly"
    | "yearly"

The frequency at which the content changes. Defaults to 'weekly'

Optionalfilename

filename?: string

The filename for the sitemap. Defaults to 'sitemap.xml'

Optionalpriority

priority?: number

The priority of the pages. Defaults to 0.5

Settings

On This Page

Properties