The @docmd/plugin-sitemap plugin generates a standard sitemap.xml file at the root of your site output directory during compilation. This provides web crawlers and search engines with a map of your site structure, ensuring all pages and version routes are indexed efficiently.

Configuration Options

Configure sitemap generation parameters in docmd.config.json:

Global Sitemap Example

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

Key Capabilities

• Canonical Domain Mapping: Resolves relative page routes to absolute URLs based on config.url.
• Version Route Indexing: Automatically indexes pages across all configured documentation versions (/v09/, /v08/, etc.).
• Per-Page Exclusion: Skips pages containing sitemap: false or noindex: true in frontmatter.
• Protocol Compliance: Produces XML formatted according to the standard sitemaps.org specification.

Page-Level Controls

Override sitemap parameters for specific documents using Page Frontmatter:

---
title: "Legacy Migration Guide"
priority: 0.3          # Lower crawl weight for legacy content
changefreq: "monthly"   # Hint to search engine crawlers
sitemap: false         # Exclude page from sitemap.xml
---