The @docmd/plugin-analytics plugin allows you to easily integrate Google Analytics into your documentation. It supports the modern Google Analytics 4 (GA4) standard, legacy Universal Analytics (UA), and includes native event tracking for interaction-heavy documentation sites.

Configuration

Enable analytics by adding your tracking credentials to the plugins section of your docmd.config.json.

Option Type Default Description
googleV4 object null Google Analytics 4 configuration (requires measurementId).
googleUA object null Universal Analytics configuration (requires trackingId).
autoEvents boolean true Automatically track clicks, downloads, and TOC interactions.
trackSearch boolean true Track search keywords used by readers.

Example

docmd.config.json
{
  "plugins": {
    "analytics": {
      "googleV4": {
        "measurementId": "G-XXXXXXX"
      },
      "autoEvents": true,
      "trackSearch": true
    }
  }
}

Tracked Events

When autoEvents is enabled, the plugin captures the following interactions automatically:

  • External links: outbound clicks to other domains.
  • Downloads: clicks on links with the download attribute or common file extensions.
  • TOC clicks: section engagement via the right-hand navigation.
  • Heading anchors: clicks on per-section permalinks.
  • Search queries: keywords typed in the search bar (debounced 1 second).
Privacy & GDPR

By default, this plugin does not anonymise IP addresses as that is now handled natively by GA4. If you require advanced cookie consent management, you can manually inject scripts using a custom plugin hook.

Previous Sitemap Next LLMs