Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 1.65 KB

plugin-google-analytics.md

File metadata and controls

63 lines (39 loc) · 1.65 KB
Raw
sidebar_position slug
6
/api/plugins/@docusaurus/plugin-google-analytics

📦 plugin-google-analytics

import APITable from '@site/src/components/APITable';

The default Google Analytics plugin. It is a JavaScript library for measuring how users interact with your website in the production build. If you are using Google Analytics 4 you might need to consider using plugin-google-gtag instead.

:::caution production only

This plugin is always inactive in development and only active in production to avoid polluting the analytics statistics.

:::

Installation {#installation}

npm install --save @docusaurus/plugin-google-analytics

:::tip

If you use the preset @docusaurus/preset-classic, you don't need to install this plugin as a dependency.

You can configure this plugin through the preset options.

:::

Configuration {#configuration}

Accepted fields:

Name Type Default Description
trackingID string Required The tracking ID of your analytics service.
anonymizeIP boolean false Whether the IP should be anonymized when sending requests.

Example configuration {#ex-config}

You can configure this plugin through preset options or plugin options.

:::tip

Most Docusaurus users configure this plugin through the preset options.

:::

// Preset Options: googleAnalytics
// Plugin Options: @docusaurus/plugin-google-analytics

const config = {
  trackingID: 'UA-141789564-1',
  anonymizeIP: true,
};