📦 plugin-google-gtag

The default Global Site Tag (gtag.js) plugin. It is a JavaScript tagging framework and API that allows you to send event data to Google Analytics, Google Ads, and Google Marketing Platform. This section describes how to configure a Docusaurus site to enable global site tag for Google Analytics.

tip

You can use Google's Tag Assistant tool to check if your gtag is set up correctly!

production only

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

Installation

npm

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

Yarn

yarn add @docusaurus/plugin-google-gtag

pnpm

pnpm add @docusaurus/plugin-google-gtag

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

Accepted fields:

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

Example configuration

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

tip

Most Docusaurus users configure this plugin through the preset options.

Preset options

If you use a preset, configure this plugin through the preset options:

docusaurus.config.js

module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        gtag: {
          trackingID: 'G-999X9XX9XX',
          anonymizeIP: true,
        },
      },
    ],
  ],
};

Plugin options

If you are using a standalone plugin, provide options directly to the plugin:

docusaurus.config.js

module.exports = {
  plugins: [
    [
      '@docusaurus/plugin-google-gtag',
      {
        trackingID: 'G-999X9XX9XX',
        anonymizeIP: true,
      },
    ],
  ],
};