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

Deprecated

This plugin is deprecated, and will become useless on July 1, 2023.

Google is moving away from Universal Analytics.

If you are still using this plugin with a UA-* tracking id, you should create a Google Analytics 4 account as soon as possible, and use @docusaurus/plugin-google-gtag instead of this plugin. More details here.

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-analytics

Yarn

yarn add @docusaurus/plugin-google-analytics

pnpm

pnpm add @docusaurus/plugin-google-analytics

astuce

If you use the preset @docusaurus/preset-classic, you don't need to install this plugin as a dependency.

Vous pouvez configurer ce plugin via les options du preset.

Configuration

Champs acceptés :

Nom	Type	Par défaut	Description
trackingID	string	Required	L'ID de suivi de votre service d'analyse.
anonymizeIP	boolean	false	Si l'adresse IP doit être anonymisée lors de l'envoi de requêtes.

Example configuration

Vous pouvez configurer ce plugin via les options du preset ou du plugin.

astuce

La plupart des utilisateurs de Docusaurus configurent ce plugin via les options du preset.

Options du preset

Si vous utilisez un preset, configurez ce plugin via le options du preset :

docusaurus.config.js

module.exports = {
  presets: [
    [
      '@docusaurus/preset-classic',
      {
        googleAnalytics: {
          trackingID: 'UA-141789564-1',
          anonymizeIP: true,
        },
      },
    ],
  ],
};

Options du plugin

Si vous utilisez un plugin autonome, fournissez des options directement au plugin :

docusaurus.config.js

module.exports = {
  plugins: [
    [
      '@docusaurus/plugin-google-analytics',
      {
        trackingID: 'UA-141789564-1',
        anonymizeIP: true,
      },
    ],
  ],
};