@docusaurus/plugin-google-gtag

What is @docusaurus/plugin-google-gtag?

@docusaurus/plugin-google-gtag is a plugin for Docusaurus that integrates Google Analytics (via gtag.js) into your Docusaurus site. It allows you to track page views and other events to gain insights into your site's traffic and user behavior.

What are @docusaurus/plugin-google-gtag's main functionalities?

Basic Setup

This feature allows you to set up the Google Analytics tracking ID and anonymize IP addresses. The tracking ID is required to link your site to your Google Analytics account.

{
  "plugins": [
    [
      "@docusaurus/plugin-google-gtag",
      {
        "trackingID": "YOUR_GOOGLE_ANALYTICS_TRACKING_ID",
        "anonymizeIP": true
      }
    ]
  ]
}

Custom Events

This feature allows you to track custom events such as button clicks. You can use the `useGtag` hook to send custom events to Google Analytics.

{
  "plugins": [
    [
      "@docusaurus/plugin-google-gtag",
      {
        "trackingID": "YOUR_GOOGLE_ANALYTICS_TRACKING_ID",
        "anonymizeIP": true
      }
    ]
  ]
}

// In your React component
import React from 'react';
import { useGtag } from '@docusaurus/plugin-google-gtag';

const MyComponent = () => {
  const gtag = useGtag();

  const handleClick = () => {
    gtag('event', 'click', {
      event_category: 'button',
      event_label: 'my_button'
    });
  };

  return <button onClick={handleClick}>Click me</button>;
};

export default MyComponent;

Other packages similar to @docusaurus/plugin-google-gtag

react-ga

react-ga is a JavaScript module that allows you to easily add Google Analytics to your React application. It provides a simple API for tracking page views and custom events. Compared to @docusaurus/plugin-google-gtag, react-ga is more general-purpose and can be used with any React application, not just Docusaurus.

gatsby-plugin-google-gtag

gatsby-plugin-google-gtag is a Gatsby plugin that integrates Google Analytics using gtag.js. It offers similar functionalities to @docusaurus/plugin-google-gtag but is specifically designed for Gatsby sites. It allows you to track page views and custom events in a Gatsby application.

next-google-analytics

next-google-analytics is a Next.js plugin for integrating Google Analytics using gtag.js. It provides an easy way to add Google Analytics to your Next.js application and track page views and custom events. Like @docusaurus/plugin-google-gtag, it is tailored for a specific framework, in this case, Next.js.

README

@docusaurus/plugin-google-gtag

Global Site Tag (gtag.js) plugin for Docusaurus.

Usage

See plugin-google-gtag documentation.