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

提示

你可以使用 Google 的 Tag Assistant 工具来检查 tag manager 是否设置正确！

仅可用于生产环境

这个插件始终不会工作在开发过程中，只在生产环境中启用，防止污染分析数据。

安装流程

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

提示

如果你已经安装了 @docusaurus/preset-classic，就不需要安装这个包了。

您可以通过预设选项配置此插件。

配置

接受的字段：

参数	类型	默认值	描述
containerId	string	必填	你的 Tag Manager 容器 ID（通常以 GTM- 开头）。

示例配置

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

提示

大多数 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',
      },
    ],
  ],
};