๐ฆ plugin-google-analytics
The default Google Analytics plugin. It is a JavaScript library for measuring how users interact with your website in the production build. If you are using Google Analytics 4 you might need to consider using plugin-google-gtag instead.
Installation
- npm
- Yarn
npm install --save @docusaurus/plugin-google-analytics
yarn add @docusaurus/plugin-google-analytics
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 analytics 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:
docusaurus.config.js
module.exports = {
presets: [
[
'@docusaurus/preset-classic',
{
googleAnalytics: {
trackingID: 'UA-141789564-1',
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-analytics',
{
trackingID: 'UA-141789564-1',
anonymizeIP: true,
},
],
],
};