📦 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.

提示

You can use Google's Tag Assistant tool to check if tag manager 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-tag-manager

Yarn

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

pnpm

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

提示

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

接受的字段：

参数	类型	默认值	描述
containerId	string	Required	Your Tag Manager container Id (usually starts with GTM-).

Example configuration

你可以通过预设选项或插件选项来配置这个插件。

提示

大多数 Docusaurus 用户通过预设选项配置此插件。

预设选项

如果你使用预设，你可以通过预设选项配置这个插件：

docusaurus.config.js

module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        googleTagManager: {
          containerId: 'GTM-12345',
        },
      },
    ],
  ],
};

插件选项

如果你用的是独立插件，直接向插件提供选项：

docusaurus.config.js

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