azat-io / vuepress-plugin-umami-analytics Goto Github PK

📗 VuePress v2 plugin for injecting Umami analytics script into your app code

License: MIT License

TypeScript 97.15% JavaScript 2.85%

umami umami-analytics vuepress vuepress-plugin

vuepress-plugin-umami-analytics's Introduction

vuepress-plugin-umami-analytics

VuePress v2 plugin for injecting Umami analytics script into your app code. Umami is a self-hosted, privacy-friendly alternative to Google Analytics.

Installation

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

Usage

Add plugin to your VuePress config:

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.

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.

Contribution

Pull requests are welcome.

vuepress-plugin-umami-analytics's People

Contributors

Stargazers

Watchers

Forkers

phundrak

vuepress-plugin-umami-analytics's Issues

[Feature] @[email protected]

在主题 vuepress2-theme-hope 中插件不生效

您好，
我在https://theme-hope.vuejs.press主题中使用了这个插件放在了config,ts中并不生效。

import { defineUserConfig } from "vuepress";
import { cut } from "nodejs-jieba";
import { umamiAnalyticsPlugin } from 'vuepress-plugin-umami-analytics'
import { searchProPlugin } from "vuepress-plugin-search-pro"
import theme from "./theme.js";

export default defineUserConfig({
  base: "/",

  lang: "zh-CN",
  title: "运维开发绿皮书",
  description: "运维开发绿皮书,放置我的笔记、搜集、摘录、实践，保持好奇心。看文需谨慎，后果很严重。",

  theme,

  plugins: [
    umamiAnalyticsPlugin({
      id: "eecd3f56-5668-4c9e-b123-b2853b91a310",
      src: "https://analytics.umami.is/script.js"
    }),
  ],
});

实际上代码

<script async="" src="https://analytics.umami.is/script.js" data-website-id=eecd3f56-5668-4c9e-b123-b2853b91a310"></script>

并没有添加进代码中。

我认为这个是个bug

最后，再次感谢你的插件，很好用！

Vue package version mismatch

I get the following when performing:

yarn add vuepress-plugin-umami-analytics
yarn dev

  throw new Error(
  ^

Error:

Vue packages version mismatch:

- [email protected]
- [email protected]

This may cause things to work incorrectly. Make sure to use the same version for both.

    at Object.<anonymous> (C:\Users\User\WebstormProjects\buildonkilt\docs\node_modules\vue-server-renderer\index.js:8:9)
    at Module._compile (node:internal/modules/cjs/loader:1256:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1310:10)
    at Module.load (node:internal/modules/cjs/loader:1119:32)
    at Module._load (node:internal/modules/cjs/loader:960:12)
    at Module.require (node:internal/modules/cjs/loader:1143:19)
    at require (node:internal/modules/cjs/helpers:110:18)
    at Object.<anonymous> (C:\Users\User\WebstormProjects\buildonkilt\docs\node_modules\@vuepress\core\lib\node\build\index.js:11:34)
    at Module._compile (node:internal/modules/cjs/loader:1256:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1310:10)
    at Module.load (node:internal/modules/cjs/loader:1119:32)
    at Module._load (node:internal/modules/cjs/loader:960:12)
    at Module.require (node:internal/modules/cjs/loader:1143:19)
    at require (node:internal/modules/cjs/helpers:110:18)
    at Object.<anonymous> (C:\Users\User\WebstormProjects\buildonkilt\docs\node_modules\@vuepress\core\lib\node\App.js:21:22)
    at Module._compile (node:internal/modules/cjs/loader:1256:14)

Node.js v18.17.0
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.```