Config

hostname

  • Type: string

  • Required: Yes

  • Details:

    The domain name where the current site is deployed, the plugin needs this option to work.

extraUrls

  • Type: string[]

  • Details:

    Extra link to be included.

    If you have some links not including in VuePress Router (normally in public directory or generated by other tools directly), you may need this option.

  • Example: ['/about.html', '/api/']

excludePaths

  • Type: string[]

  • Default: ['/404.html']

  • Details:

    Urls excluding from sitemap, starting with absolute path.

    By default, all the urls generated by VuePress (excluding 404 page) will be added into sitemap.

devServer

  • Type: boolean

  • Default: false

  • Details:

    Whether enabled in devServer.

Tips

For performance reasons, we do not provide hot reload. Reboot your devServer to sync your changes.

devHostname

  • Type: string

  • Default: "http://localhost:${port}"

  • Details:

    Hostname to use in devServer

sitemapFilename

  • Type: string

  • Default value: "sitemap.xml"

  • Details:

    The output filename, relative to output directory.

sitemapXSLFilename

  • Type: string

  • Default value: "sitemap.xsl"

  • Details:

    Output xsl filename, relative to dest folder.

sitemapXSLTemplate

  • Type: string

  • Default value: "@vuepress/plugin-sitemap/templates/sitemap.xsl"

  • Details:

    XSL content used as template.

changefreq

  • Type: "always" | "hourly" | "daily" | "weekly" |"monthly" | "yearly" | "never"

  • Default value: "daily"

  • Details:

    Page default update frequency, will be overridden by sitemap.changefreq in Frontmatter.

priority

  • Type: number

  • Default: 0.5

  • Details:

    Page priority, from 0 to 1.

modifyTimeGetter

  • Type: (page: Page, app: App) => string

  • Details:

    Last modify time getter. By default, the plugin will use the timestamp generated by git plugin.