Skip to content

plugin-vercel-analytics.mdx

Latest commit

 

History

History
57 lines (41 loc) · 1.45 KB

plugin-vercel-analytics.mdx

File metadata and controls

57 lines (41 loc) · 1.45 KB
sidebar_position 11
slug /api/plugins/@docusaurus/plugin-vercel-analytics

📦 plugin-vercel-analytics

import APITable from '@site/src/components/APITable';

Vercel Analytics provides comprehensive insights into your website's visitors, tracking top pages, referrers, and demographics like location, operating systems, and browser info.

:::warning production only

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

:::

Installation {#installation}

npm install --save @docusaurus/plugin-vercel-analytics

Configuration {#configuration}

Accepted fields:

<APITable>
Name Type Default Description
mode string 'auto' Override the automatic environment detection. Read the official docs for details.
debug boolean undefined Enable browser console logging of analytics events. Read the official docs for details. 
</APITable>

Example configuration {#ex-config}

You can configure this plugin through plugin options.

export default {
  plugins: [
    [
      'vercel-analytics',
      {
        debug: true,
        mode: 'auto',
      },
    ],
  ],
};