vuepress-plugin-umami-analytics/readme.md

VuePress plugin for using Umami analytics

# vuepress-plugin-umami-analytics

<img src="https://avatars.githubusercontent.com/u/48539483?s=100" align="right" alt="VuePress" />

[![Version](https://img.shields.io/npm/v/vuepress-plugin-umami-analytics.svg?color=4fb17b&labelColor=2a2f44)](https://npmjs.com/package/vuepress-plugin-umami-analytics)
[![Monthly Download](https://img.shields.io/npm/dm/vuepress-plugin-umami-analytics.svg?color=4fb17b&labelColor=2a2f44)](https://npmjs.com/package/vuepress-plugin-umami-analytics)
[![GitHub License](https://img.shields.io/badge/license-MIT-4fb17b.svg?color=4fb17b&labelColor=2a2f44)](https://github.com/azat-io/eslint-plugin-de-morgan/blob/main/license.md)

VuePress v2 plugin for injecting [Umami](https://umami.is) analytics script into your app code. Umami is a self-hosted, privacy-friendly alternative to Google Analytics.

## Installation

```sh
npm install --save vuepress-plugin-umami-analytics
```

## Usage

Add plugin to your VuePress config:

```js
import { umamiAnalyticsPlugin } from 'vuepress-plugin-umami-analytics'

let isProd = process.env.NODE_ENV === 'production'

export default {
  plugins: [
    isProd
      ? umamiAnalyticsPlugin({
          /* options */
        })
      : [],
  ],
}
```

## Options

For more details on the configuration of the tracker, see the [official documentation](https://umami.is/docs/tracker-configuration).

### id

- Type: `string`

- Required: `true`

- Details:

  Add website to Umami analytics and get parameters from tracking code. Put data-website-id here.

### src

- Type: `string`

- Required: `true`

- Details:

  Link to Umami analytics script.

### hostUrl

- Type: `string`

- Required: `false`

- Default value: `null`

- Details:

  Send data to this host instead of the one where the script is located.

### autoTrack

- Type: `boolean`

- Required: `false`

- Default value: `true`

- Details:

  Set to false to disable tracking all pageviews and events.

### doNotTrack

- Type: `boolean`

- Required: `false`

- Default value: `false`

- Details:

  Whether to respect the browser's Do Not Track setting.

### cache

- Type: `boolean`

- Required: `false`

- Default value: `false`

- Details:

  Whether to cache some data to improve performance. Be careful, it will use session storage, you may have to inform your users.

### domains

- Type: `string[]`

- Required: `false`

- Default value: `null`

- Details:

  Only run the tracker on the domains specified. With a `null` value, tracker is active everywhere.

![Umami tracking code](https://user-images.githubusercontent.com/5698350/190417132-fcedc6cb-636d-4634-a682-837a6f56c797.png)

## Contribution

Pull requests are welcome.