Docusausus GoatCounter Plugin

📝 Table of Contents

• About
• Install
• Getting Started
• Contributors

🧐 About

This plugin adds GoatCounter web analytics to your Docusaurus v3 project. It has zero dependencies, the only thing this plugin does is including the tracking script in your production build outputs.

🚀 Install

First, add the plugin as a dependency to your project.

# Yarn
yarn add docusaurus-plugin-goatcounter

# npm
npm install docusaurus-plugin-goatcounter

Then, configure Docusaurus to use your plugin by adding the following to docusaurus.config.js. Replace your-goatcounter-code with the identifier of your GoatCounter instance. E.g. if you access GoatCounter at https://acmecorp.goatcounter.com, then your code is acmecorp.

module.exports = {
  plugins: ['docusaurus-plugin-goatcounter'],
  themeConfig: {
    goatcounter: {
      code: 'your-goatcounter-code',
    },
  },
};

Warning

When building your website for production, set NODE_ENV=production. If not, the plugin will not inject the Goatcounter tag, in order to prevent including non-production traffic in your Goatcounter statistics.

🏁 Getting Started

Below is a list of commands you can use for development.

yarn start

Runs the project in development/watch mode.

yarn build

Bundles the package to the dist folder.

yarn test

Runs the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit.

✨ Contributors

Thanks goes to these wonderful people (emoji key):

Adriaan Knapen 💻 🔧 📖 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!