mirror of https://github.com/kremalicious/gatsby-plugin-matomo.git synced 2024-12-22 09:13:19 +01:00

🥂 Gatsby plugin to add Matomo (formerly Piwik) onto a site. https://kremalicious.com/gatsby-plugin-matomo

Go to file

Matthias Kretschmann 49640f4d37 readme updates * add project image * switch features & usage around * add note about production mode		2018-05-08 18:00:57 +02:00
src	do nothing on route updates when piwik isn't loaded and in development	2018-05-08 12:45:47 +02:00
.babelrc	add Travis, add badges, add semi-auto releases	2018-05-07 20:26:51 +02:00
.editorconfig	initial commit 🍹	2018-05-07 19:28:15 +02:00
.eslintrc	initial commit 🍹	2018-05-07 19:28:15 +02:00
.gitignore	initial commit 🍹	2018-05-07 19:28:15 +02:00
.npmignore	add Travis, add badges, add semi-auto releases	2018-05-07 20:26:51 +02:00
.travis.yml	add Travis, add badges, add semi-auto releases	2018-05-07 20:26:51 +02:00
gatsby-plugin-matomo.png	readme updates	2018-05-08 18:00:57 +02:00
LICENSE	initial commit 🍹	2018-05-07 19:28:15 +02:00
package.json	Release 0.1.2	2018-05-08 13:16:18 +02:00
README.md	readme updates	2018-05-08 18:00:57 +02:00

README.md

gatsby-plugin-matomo

⚛️📄🚀 Gatsby plugin to add Matomo (formerly Piwik) onto a site.

Features

Plugin uses sensible defaults prioritizing user experience & privacy:

include tracking code in all server-side rendered routes
track all route views as custom events
load tracking scripts at end of body tag
use image tracking fallback for noscript
don't load anything when visitor has Do Not Track enabled
don't load anything in non-production environments

Usage

First, install the plugin from your project's root:
```
cd yourproject/
npm i gatsby-plugin-matomo
```

Then load the plugin from your gatsby-config.js and set the required variables:

plugins: [
  {
    resolve: 'gatsby-plugin-matomo',
    options: {
      siteId: 'YOUR_SITE_ID',
      siteUrl: 'https://YOUR_LIVE_SITE_URL.COM',
      matomoUrl: 'https://YOUR_MATOMO_URL.COM',
    },
  },
]

That's it!

NOTE: This plugin only generates output when run in production mode. To test your tracking code, run: gatsby build && gatsby serve.

Development

npm i
npm run build

# publishing to npm & GitHub releases
# uses https://github.com/webpro/release-it
npm run release
npm run release-minor
npm run release-major

License

The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Made with ♥ by Matthias Kretschmann (@kremalicious)

Say thanks with BTC: 35UUssHexVK48jbiSgTxa4QihEoCqrwCTG

Say thanks with ETH: 0x04354F554536DA108726829207958d3E277f0210