📦 docusaurus-plugin-umami

Umami Analytics plugin for Docusaurus v2.

⚠️ production only

This plugin is always inactive in development and only active in production to avoid polluting the analytics statistics.

Installation

Install the plugin with npm:

npm install --save @dipakparmar/docusaurus-plugin-umami

or with yarn:

yarn add @dipakparmar/docusaurus-plugin-umami

or with pnpm:

pnpm install @dipakparmar/docusaurus-plugin-umami

or with bun:

bun install @dipakparmar/docusaurus-plugin-umami

Configuration

Add the plugin and websiteID and analyticsDomain to your docusaurus.config.js:

module.exports = {
  plugins: [
    [
      "@dipakparmar/docusaurus-plugin-umami",
      /** @type {import('@dipakparmar/docusaurus-plugin-umami').Options} */
      ({
        websiteID: "your-website-id", // Required
        analyticsDomain: "analytics.mydomain.com", // Required
        scriptName: "script.js", // Optional, defaults to script.js
        dataHostURL: "", // Optional
        dataAutoTrack: true, // Optional, defaults to true
        dataDoNotTrack: false, // Optional, defaults to false
        dataCache: false, // Optional, defaults to false
        dataDomains: "", // Optional, comma separated list of domains, *Recommended*
        dataExcludeSearch: false, // Optional, defaults to false
        dataExcludeHash: false, // Optional, defaults to false
        dataTag: "", // Optional
        dataBeforeSend: "beforeSendHandler", // Optional
      }),
    ],
  ],
};

Options

Accepted fields:

| Name | Type | Default | Description | | ------------------- | --------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | websiteID | string | Required | The unique website ID from your Umami Analytics. | | analyticsDomain | string | Required | Your domain of where Umami Analytics is hosted. | | scriptName | string | script.js | Name of your custom tracker script. | | dataHostURL | string | | By default, Umami will send data to wherever the script is located. You can override this to send data to another location. | | dataAutoTrack | boolean | true | By default, Umami tracks all pageviews and events for you automatically. You can disable this behavior and track events yourself using the tracker functions. | | dataDoNotTrack | boolean | false | Configure Umami to respect the visitor's Do Not Track setting. | | dataCache | boolean | false | If you get a lot of pageviews from the same user, for example in a forum website, you can cache some data to improve the performance of the tracking script. | | dataDomains | string | | If you want the tracker to only run on specific domains, you can add them to your tracker script. This is a comma delimited list of domain names. Helps if you are working in a staging/development environment. | | dataExcludeSearch | boolean | false | Configure the tracker to not record query parameters in the URL. | | dataExcludeHash | boolean | false | Configure the tracker to not record URL hashes. | | dataTag | string | | Add a tag to your website's data for segmentation. | | dataBeforeSend | string | | Define a function that will be called before sending the data. Useful for modifying the data before it's sent to the server. |

Reference:

• Docusuarus Plugin Readme Example from https://github.com/sgromkov/docusaurus-plugin-yandex-metrica
• Plugin Architecture: https://docusaurus.io/docs/api/plugin-methods#example
• Umami Analytics Tracker Configuration: https://umami.is/docs/tracker-configuration