The @docmd/plugin-sitemap plugin generates a sitemap.xml file at the root of your build directory. This provides search engines with a comprehensive map of your site’s architecture, ensuring that all pages - including versioned documentation - are crawled and indexed.

Configuration

Enable sitemap generation by providing your siteUrl in the root configuration. You can customise the crawl weight within the plugins object.

Example

{
  "url": "https://docs.example.com",
  "plugins": {
    "sitemap": {
      "defaultChangefreq": "weekly",
      "defaultPriority": 0.8
    }
  }
}

Features

• Canonical URLs: resolves page paths to clean public URLs based on your url config.
• Versioned discovery: includes pages from every configured version (/v1/, /v2/, etc.).
• Per-page exclusions: skip pages with sitemap: false in frontmatter.
• Standard XML: output follows the sitemaps.org protocol supported by every major search engine.

Page-Level Controls

Override sitemap behaviour for specific pages using frontmatter:

---
title: "Archive Page"
priority: 0.3          # Lower weight for legacy content
changefreq: "monthly"   # Hint to crawlers
sitemap: false         # Exclude this specific page
---