{"id":16483300,"url":"https://github.com/dipakparmar/docusaurus-plugin-umami","last_synced_at":"2025-03-16T18:31:41.437Z","repository":{"id":52678317,"uuid":"498150751","full_name":"dipakparmar/docusaurus-plugin-umami","owner":"dipakparmar","description":"Umami Analytics plugin for Docusaurus v2.","archived":false,"fork":false,"pushed_at":"2025-02-03T19:26:23.000Z","size":204,"stargazers_count":15,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-27T12:14:14.735Z","etag":null,"topics":["analytics","docusaurus-plugin","docusaurus-plugin-umami","docusaurus-v2","umami","umami-analytics","umami-plugin"],"latest_commit_sha":null,"homepage":"https://npmjs.org/package/@dipakparmar/docusaurus-plugin-umami","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dipakparmar.png","metadata":{"files":{"readme":"README.MD","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-31T01:46:44.000Z","updated_at":"2025-01-20T15:08:24.000Z","dependencies_parsed_at":"2023-12-03T22:25:24.642Z","dependency_job_id":"5a0533aa-01ca-4617-8b92-8fb828c204f7","html_url":"https://github.com/dipakparmar/docusaurus-plugin-umami","commit_stats":{"total_commits":36,"total_committers":2,"mean_commits":18.0,"dds":"0.16666666666666663","last_synced_commit":"2a20b43495d459257bc0a806657095864c502192"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dipakparmar%2Fdocusaurus-plugin-umami","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dipakparmar%2Fdocusaurus-plugin-umami/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dipakparmar%2Fdocusaurus-plugin-umami/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dipakparmar%2Fdocusaurus-plugin-umami/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dipakparmar","download_url":"https://codeload.github.com/dipakparmar/docusaurus-plugin-umami/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243826783,"owners_count":20354220,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analytics","docusaurus-plugin","docusaurus-plugin-umami","docusaurus-v2","umami","umami-analytics","umami-plugin"],"created_at":"2024-10-11T13:13:33.093Z","updated_at":"2025-03-16T18:31:40.784Z","avatar_url":"https://github.com/dipakparmar.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 📦 docusaurus-plugin-umami\n\n[Umami Analytics](https://umami.is) plugin for [Docusaurus v2](https://docusaurus.io/).\n\n[![Version](https://img.shields.io/npm/v/@dipakparmar/docusaurus-plugin-umami.svg)](https://npmjs.org/package/@dipakparmar/docusaurus-plugin-umami)\n[![Downloads/week](https://img.shields.io/npm/dw/@dipakparmar/docusaurus-plugin-umami)](https://npmjs.org/package/@dipakparmar/docusaurus-plugin-umami)\n[![License](https://img.shields.io/npm/l/@dipakparmar/docusaurus-plugin-umami.svg)](https://github.com/dipakparmar/docusaurus-plugin-umami/blob/main/package.json)\n\n### ⚠️ production only\n\nThis plugin is always inactive in development and only active in production to avoid polluting the analytics statistics.\n\n## Installation\n\nInstall the plugin with npm:\n\n```bash\nnpm install --save @dipakparmar/docusaurus-plugin-umami\n```\n\nor with yarn:\n\n```bash\nyarn add @dipakparmar/docusaurus-plugin-umami\n```\n\nor with pnpm:\n\n```bash\npnpm install @dipakparmar/docusaurus-plugin-umami\n```\n\nor with bun:\n\n```bash\nbun install @dipakparmar/docusaurus-plugin-umami\n```\n\n## Configuration\n\nAdd the plugin and websiteID and analyticsDomain to your `docusaurus.config.js`:\n\n```js\nmodule.exports = {\n  plugins: [\n    [\n      \"@dipakparmar/docusaurus-plugin-umami\",\n      /** @type {import('@dipakparmar/docusaurus-plugin-umami').Options} */\n      ({\n        websiteID: \"your-website-id\", // Required\n        analyticsDomain: \"analytics.mydomain.com\", // Required\n        scriptName: \"\", // Optional\n        dataHostURL: \"\", // Optional\n        dataAutoTrack: true, // Optional\n        dataDoNotTrack: true, // Optional\n        dataCache: true, // Optional\n        dataDomains: \"\", // comma separated list of domains, *Recommended*\n      }),\n    ],\n  ],\n};\n```\n\n### Options\n\nAccepted fields:\n\n\u003csmall\u003e\n\n| Name              | Type      | Default      | Description                                                                                                                                                                                                      |\n| ----------------- | --------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `websiteID`       | `string`  | **Required** | The unique website ID from your Umami Analytics.                                                                                                                                                                 |\n| `analyticsDomain` | `string`  | **Required** | Your domain of where Umami Analytics is hosted.                                                                                                                                                                  |\n| `scriptName`      | `string`  | `script.js`  | Name of your custom tracker script.                                                                                                                                                                              |\n| `dataHostURL`     | `string`  |              | By default, Umami will send data to wherever the script is located. You can override this to send data to another location.                                                                                      |\n| `dataAutoTrack`   | `boolean` |              | By default, Umami tracks all pageviews and events for you automatically. You can disable this behavior and track events yourself using the tracker functions.                                                    |\n| `dataDoNotTrack`  | `boolean` |              | Configure Umami to respect the visitor's Do Not Track setting.                                                                                                                                                   |\n| `dataCache`       | `boolean` |              | 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.                                                     |\n| `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. |\n| `dataExcludeSearch` | `boolean` |  false           | Configure the tracker to not record query parameters. |URL.                                                                                                                                                                             |\n\n\u003c/small\u003e\n\n## Reference:\n\n- Docusuarus Plugin Readme Example from https://github.com/sgromkov/docusaurus-plugin-yandex-metrica\n- Plugin Architecture: https://docusaurus.io/docs/api/plugin-methods#example\n- Umami Analytics Tracker Configuration: https://umami.is/docs/tracker-configuration\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdipakparmar%2Fdocusaurus-plugin-umami","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdipakparmar%2Fdocusaurus-plugin-umami","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdipakparmar%2Fdocusaurus-plugin-umami/lists"}