Plugins

Analytics Plugin

Add analytics tracking to your docs

The analytics plugin injects tracking scripts into your documentation site. It supports Google Analytics, Plausible, and Umami.

Installation

pnpm add @barodoc/plugin-analytics@latest

Google Analytics

{
  "plugins": [
    ["@barodoc/plugin-analytics", {
      "provider": "google",
      "id": "G-XXXXXXXXXX"
    }]
  ]
}

Plausible

{
  "plugins": [
    ["@barodoc/plugin-analytics", {
      "provider": "plausible",
      "domain": "docs.example.com"
    }]
  ]
}

Umami

{
  "plugins": [
    ["@barodoc/plugin-analytics", {
      "provider": "umami",
      "websiteId": "your-website-id",
      "src": "https://analytics.example.com/umami.js"
    }]
  ]
}

Options

Google Analytics

provider'google'required

Set to "google"

idstringrequired

Google Analytics measurement ID (e.g. "G-XXXXXXXXXX")

Plausible

provider'plausible'required

Set to "plausible"

domainstringrequired

Your site domain

srcstring

Custom Plausible script URL. Default: "https://plausible.io/js/script.js"

Umami

provider'umami'required

Set to "umami"

websiteIdstringrequired

Your Umami website ID

srcstringrequired

Umami script URL