📦 plugin-google-tag-manager

A plugin for adding Google Tag Manager (gtm.js) to a Docusaurus site. Use this plugin in conjunction with the standard gtag plugin for in-depth analysis of how users are using your site.

tip

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

:::warning 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-tag-manager

Yarn

yarn add @docusaurus/plugin-google-tag-manager

pnpm

pnpm add @docusaurus/plugin-google-tag-manager

Bun

bun add @docusaurus/plugin-google-tag-manager

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
containerId	string	Required	Your Tag Manager container Id (usually starts with GTM-).

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',
      {
        googleTagManager: {
          containerId: 'GTM-12345',
        },
      },
    ],
  ],
};

Plugin options

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

docusaurus.config.js

module.exports = {
  plugins: [
    [
      '@docusaurus/plugin-google-tag-manager',
      {
        containerId: 'GTM-12345',
      },
    ],
  ],
};