docusaurus-plugin-goatcounter
TypeScript icon, indicating that this package has built-in type declarations

3.0.0 • Public • Published

Docusausus GoatCounter Plugin

License Project Status: Active – The project has reached a stable, usable state and is being actively developed. Depfu npm npm GitHub stars All Contributors

📝 Table of Contents

🧐 About

This plugin adds GoatCounter web analytics to your Docusaurus v2 project. It has zero dependencies as the only thing it needs to do is include the tracking script in your 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 acecss GoatCounter at https://acmecorp.goatcounter.com, then your code is acmecorp.

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

When building your website, make sure that NODE_ENV=production, as the plugin will avoid injecting the Goatcounter tag in development environments.

🏁 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!

Readme

Keywords

none

Package Sidebar

Install

npm i docusaurus-plugin-goatcounter

Weekly Downloads

1,423

Version

3.0.0

License

MIT

Unpacked Size

19 kB

Total Files

12

Last publish

Collaborators

  • addono