gatsby-plugin-plausible


A Gatsby plugin for adding Plausible analytics to your Gatsby site.

The plugin includes the Plausible tracking script. It supports using a custom domain and excluding specific paths from recording page views.

---

- Install
- Manual
- Gatsby Recipe
- How to use
- Options
- Pageview events
- Triggering custom events
- Changelog
- License

Install

$3

1. Install gatsby-plugin-plausible

npm install --save gatsby-plugin-plausible

2. Add plugin to gatsby-config.js

``javascript
// In your gatsby-config.js
module.exports = {
plugins: [
// The only required option is the domain
{
resolve: gatsby-plugin-plausible,
options: {
domain: aquil.io,
},
},
],
};
`

$3

This will install gatsby-plugin-plausible and add a sample configuration.

1. Upgrade gatsby-cli and gatsby to the latest version:

npm install -g gatsby-cli@latest
npm install gatsby@latest

2. Run the recipe
gatsby recipes https://raw.githubusercontent.com/Aquilio/gatsby-plugin-plausible/master/gatsby-recipe-plausible.mdx

3. Update gatsby-config.js options.

To read more about recipes check out the announcement.

How to use

_NOTE: By default, this plugin only generates output when run in production mode. To test your tracking code, run gatsby build && gatsby serve_.

$3

| Option | Explanation |
| -------------- | ------------------------------------------------------ |
| domain | The domain configured in Plausible (required) |
| customDomain | Custom domain (if configured in Plausible's dashboard) |
| excludePaths | Array of pathnames where page views will not be sent |

$3

Pageviews are sent automatically when a user changes routes, including the initial load of your site.

$3

To track goals and conversions you have to trigger custom events first.

`js
window.plausible('Signup', {
callback: () => console.info('Sent Signup event'),
});
`

The event name can be anything. The second argument is an object with options. The only supported option is callback` that is called once the event has been sent.

_NOTE: Custom events will not show up right away. You have to configure a goal in your Plausible dashboard_.

Changelog

See CHANGELOG.md.

License

MIT © Pixelplicity