@hywax/vitepress-yandex-metrika

VitePress Yandex Metrika

Русский | English

Плагин для VitePress для отслеживания статистики Яндекс Метрики.

Оглавление

• Особенности
• Установка
• Использование
  • Подключение
  • Конфигурация
• Вкладчики
• Лицензия

🎯 Особенности

• 📊 Поддержка нескольких счетчиков
• ✨ Корректная работа с SPA приложениями
• ✅ Поддержка всех настроек метрики
• 🌐 Возможность использовать CDN для счетчиков
• 0️⃣ 0 зависимостей
• 🪄️ Поддержка TypeScript

✨ Установка

# Использование pnpm
pnpm add @hywax/vitepress-yandex-metrika -D

# Использование yarn
yarn add @hywax/vitepress-yandex-metrika -D

# Использование npm
npm install @hywax/vitepress-yandex-metrika -D

⚡ Использование

🚀 Подключение

Добавьте yandexMetrika в раздел темы enhanceApp в index.ts.

// .vitepress/theme/index.ts
import type { Theme } from 'vitepress'
import { yandexMetrika } from '@hywax/vitepress-yandex-metrika'
import DefaultTheme from 'vitepress/theme'

export default {
  extends: DefaultTheme,
  enhanceApp({ router }) {
    yandexMetrika(router, {
      counter: {
        id: 12345678
      },
    })
  },
} satisfies Theme

⚙️ Конфигурация

Вы можете настроить плагин yandexMetrika, передав необходимые параметры в объект настроек.

export interface YandexMetrikaOptions {
  enabled?: boolean // по умолчанию: true
  counter: YandexMetrikaCounter | YandexMetrikaCounter[]
  cdn?: {
    tag?: string // по умолчанию: https://mc.yandex.ru/metrika/tag.js
    watch?: string // по умолчанию: https://mc.yandex.ru/watch
  }
}

export interface YandexMetrikaCounter {
  id: number
  initParams?: {
    defer?: boolean // по умолчанию: false
    clickmap?: boolean // по умолчанию: true
    trackLinks?: boolean // по умолчанию: true
    accurateTrackBounce?: boolean // по умолчанию: true
    webvisor?: boolean // по умолчанию: false
    ecommerce?: boolean | string | Array<string | boolean> // по умолчанию: false
    trustedDomains?: string[] // по умолчанию: -
    childIframe?: boolean // по умолчанию: false
    type?: number // по умолчанию: 0
    triggerEvent?: boolean // по умолчанию: false
  }
}

Дополнительную информацию можно найти на странице документации.

🏆 Вкладчики

Огромное спасибо всем, кто помогает улучшать проект. Благодаря вам проект может развиваться!

📄 Лицензия

Основой VitePress Yandex Metrika являет открытый исходный код, в соответствии MIT License.