Code Monkey home page Code Monkey logo

vitepress-yandex-metrika's Introduction

vitepress-yandex-metrika

VitePress Yandex Metrika

npm version npm downloads License

Русский | 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 DefaultTheme from 'vitepress/theme'
import { yandexMetrika } from '@hywax/vitepress-yandex-metrika'

export default {
  extends: DefaultTheme,
  enhanceApp(ctx) {
    yandexMetrika(ctx, {
      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 Вкладчики

📄 Лицензия

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

vitepress-yandex-metrika's People

Contributors

dependabot[bot] avatar hywax avatar hywax-assistant avatar

Stargazers

 avatar  avatar

Watchers

 avatar

vitepress-yandex-metrika's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

  • chore(deps): update devdependency @types/node to ^20.11.10

Detected dependencies

github-actions
.github/workflows/main.yml
  • actions/checkout v4
  • actions/setup-node v4
  • pnpm/action-setup v2
npm
package.json
  • @antfu/eslint-config ^2.6.3
  • @commitlint/cli ^18.6.0
  • @commitlint/config-conventional ^18.6.0
  • @types/node ^20.11.9
  • @vitest/coverage-v8 ^1.2.2
  • camelcase ^8.0.0
  • changelogen ^0.5.5
  • eslint ^8.56.0
  • husky ^9.0.6
  • lint-staged ^15.2.0
  • typescript ^5.3.3
  • vite ^5.0.12
  • vite-plugin-dts ^3.7.2
  • vitest ^1.2.2
  • vite ^4.0.0 || ^5.0.0
  • vitepress 1.0.0-rc.40

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.