Getting Started

Plausible for Docusaurus integrates Plausible Analytics into your Docusaurus site. It injects the Plausible tracking script, handles route-change pageviews automatically, and supports the full range of Plausible script extensions.

This plugin was forked from InfraCost's docusaurus-plugin-plausible, originally inspired by gatsby-plugin-plausible. It has been rewritten in TypeScript and updated for Docusaurus v3+.

Installation

npm

npm install @homotechsual/docusaurus-plugin-plausible

Yarn

yarn add @homotechsual/docusaurus-plugin-plausible

pnpm

pnpm add @homotechsual/docusaurus-plugin-plausible

Bun

bun add @homotechsual/docusaurus-plugin-plausible

Quick Start

Add the plugin to your docusaurus.config.ts:

import type { Config } from '@docusaurus/types'
import plausiblePlugin, { type PluginOptions } from '@homotechsual/docusaurus-plugin-plausible'

const config: Config = {
  plugins: [
    [
      plausiblePlugin,
      {
        domain: 'your-site.com',
      } satisfies PluginOptions,
    ],
  ],
}

export default config

Or in docusaurus.config.js:

export default {
  plugins: [
    [
      '@homotechsual/docusaurus-plugin-plausible',
      {
        domain: 'your-site.com',
      },
    ],
  ],
}

The tracking script is only injected in production builds (NODE_ENV === 'production'). No analytics fire during docusaurus start.