https://github.com/phiilu/gatsby-plugin-umami

Gatsby plugin to add Umami (https://umami.is) to a Gatsby site
https://github.com/phiilu/gatsby-plugin-umami

gatsby gatsby-plugin gatsby-plugin-umami gatsbyjs hacktoberfest react umami umami-analytics

Last synced: 3 months ago
JSON representation

Gatsby plugin to add Umami (https://umami.is) to a Gatsby site

• Host: GitHub
• URL: https://github.com/phiilu/gatsby-plugin-umami
• Owner: phiilu
• License: mit
• Created: 2020-09-28T19:38:34.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-04-25T07:04:58.000Z (over 1 year ago)
• Last Synced: 2024-09-29T14:29:49.456Z (3 months ago)
• Topics: gatsby, gatsby-plugin, gatsby-plugin-umami, gatsbyjs, hacktoberfest, react, umami, umami-analytics
• Language: JavaScript
• Homepage:
• Size: 253 KB
• Stars: 5
• Watchers: 1
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gatsby-plugin-umami

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

Easily add [Umami](https://umami.is/) to your Gatsby site.

## Install

`npm install --save gatsby-plugin-umami`

## How to use

```javascript

// In your gatsby-config.js

plugins: [

  {

    resolve: `gatsby-plugin-umami`,

    options: {

      websiteId: "UMAMI_WEBSITE_ID",

      srcUrl: "https://umami.example.com/script.js",

      includeInDevelopment: false,

      autoTrack: true,

      respectDoNotTrack: true,

      dataCache: false,

      dataDomains: "example.com,example2.com",

    },

  },

];

```

## Configuration

- `websiteId` - Required. The website id of your umami site

- `srcUrl` - Required. The url to the hosted `script.js`

- `includeInDevelopment` - Optional. Defaults to `false`

- `autoTrack` - Optional. Enables [umami auto track](https://umami.is/docs/tracker-config) feature. Defaults to `true`

- `respectDoNotTrack` - Optional. Enables [umami respect Do Not Track](https://umami.is/docs/tracker-config) feature. Defaults to `true`

- `dataCache` - Optional. Improves performance. Defaults to `false`

- `dataDomains` - Optional. Allows tracking only on the specified domains. No default.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
William Weiss
💻

    
Matt Banner
🐛

    
Florian Kapfenberger
💬 📖 👀 💻 🔧

  

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