๐ฆ 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, in the production build. 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!
Installation
- npm
- Yarn
npm install --save @docusaurus/plugin-google-gtag
yarn add @docusaurus/plugin-google-gtag
tip
If you have installed @docusaurus/preset-classic
, you don't need to install it as a dependency.
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
Here's an example configuration object.
You can provide it as preset options or plugin options.
tip
Most Docusaurus users configure this plugin through the preset options.
const config = {
trackingID: 'UA-141789564-1',
anonymizeIP: true,
};
Preset options
If you use a preset, configure this plugin through the preset options:
module.exports = {
presets: [
[
'@docusaurus/preset-classic',
{
gtag: {
trackingID: 'UA-141789564-1',
anonymizeIP: true,
},
},
],
],
};
Plugin options
If you are using a standalone plugin, provide options directly to the plugin:
module.exports = {
plugins: [
[
'@docusaurus/plugin-google-gtag',
{
trackingID: 'UA-141789564-1',
anonymizeIP: true,
},
],
],
};