Pirsch plugin for Docusaurus v3

An easy to use plugin to use Pirsch Analytics with Docusaurus v3 sites.

Installing the plugin

yarn add @polymetis-apps/pirsch-docusaurus

or

npm install @polymetis-apps/pirsch-docusaurus --save

Configuring the plugin

After installing the plugin, simply add it to your docusaurus config. It only takes one parameter, your identification code.

// docusaurus.config.js
module.exports = {
  plugins: [
    ['@polymetis-apps/pirsch-docusaurus', {
        code: "XXXXXXXXXXXXXXXXXXXXXXXXXXXX" 
      }],
  ]
  };

And that is it! You should be ready to go immediately. Please note that Pirsch ignores requests made from localhost, so your local tests should not show up in your dashboard.

Compatibility notes:

• This plugin supports Docusaurus v3 only. Requires Docusaurus v3.0.0 or higher.
• This release now requires Node 20+. Update your runtime and CI to Node 20 to use the latest plugin version.

If you encounter peer dependency conflicts in your site, updating react, react-dom, and @mdx-js/react to versions compatible with Docusaurus v3 (React 18, MDX v3) may be required.

Compatibility notes:

• This plugin supports Docusaurus v3 only. Requires Docusaurus v3.0.0 or higher.
• This release now requires Node 20+. Update your runtime and CI to Node 20 to use the latest plugin version.

If you encounter peer dependency conflicts in your site, updating react, react-dom, and @mdx-js/react to versions compatible with Docusaurus v3 (React 18, MDX v3) may be required.

Questions?

Talk to us!