Skip to main content
Version: 2.2.0

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

production only

This plugin is always inactive in development and only active in production to avoid polluting the analytics statistics.

Installation

npm install --save @docusaurus/plugin-google-analytics
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:

NameTypeDefaultDescription
trackingIDstringRequiredThe tracking ID of your analytics service.
anonymizeIPbooleanfalseWhether the IP should be anonymized when sending requests.

Example configuration

You can configure this plugin through preset options or plugin options.

tip

Most Docusaurus users configure this plugin through the 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,
},
},
],
],
};