https://github.com/addono/docusaurus-plugin-goatcounter

Adds GoatCounter web analytics to Docusaurus
https://github.com/addono/docusaurus-plugin-goatcounter

analytics docusaurus docusaurus-plugin docusaurus-v2 goatcounter plugin privacy

Last synced: about 2 months ago
JSON representation

Adds GoatCounter web analytics to Docusaurus

• Host: GitHub
• URL: https://github.com/addono/docusaurus-plugin-goatcounter
• Owner: Addono
• License: mit
• Created: 2020-10-03T12:57:03.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-11T00:53:47.000Z (9 months ago)
• Last Synced: 2024-04-14T05:47:23.697Z (9 months ago)
• Topics: analytics, docusaurus, docusaurus-plugin, docusaurus-v2, goatcounter, plugin, privacy
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/docusaurus-plugin-goatcounter
• Size: 1.75 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Docusausus GoatCounter Plugin

[![License](https://img.shields.io/github/license/Addono/docusaurus-plugin-goatcounter?style=flat-square)](https://github.com/Addono/docusaurus-plugin-goatcounter/blob/master/LICENSE)

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://img.shields.io/badge/project%20status-Active-greengrass?style=flat-square)](https://www.repostatus.org/#active)

[![Depfu](https://img.shields.io/depfu/Addono/docusaurus-plugin-goatcounter?style=flat-square)](https://depfu.com/github/Addono/docusaurus-plugin-goatcounter)

[![npm](https://img.shields.io/npm/dt/docusaurus-plugin-goatcounter?style=flat-square)](https://www.npmjs.com/package/docusaurus-plugin-goatcounter)

[![npm](https://img.shields.io/npm/v/docusaurus-plugin-goatcounter?style=flat-square)](https://www.npmjs.com/package/docusaurus-plugin-goatcounter)

[![GitHub stars](https://img.shields.io/github/stars/Addono/docusaurus-plugin-goatcounter?style=flat-square)](https://github.com/Addono/docusaurus-plugin-goatcounter/stargazers)

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)

## 📝 Table of Contents

- [About](#about)

- [Install](#install)

- [Getting Started](#getting_started)

- [Contributors](#contributors)

## 🧐 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.

```bash

# 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`.

```js

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](https://allcontributors.org/docs/en/emoji-key)):

  

    
Adriaan Knapen
💻 🔧 📖 ⚠️

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!