Skip to main content

Extensions

Plausible's script extensions add tracking capabilities beyond basic pageviews. Each extension appends a segment to the script filename. The plugin builds the filename automatically from your config.

For example, enabling hashBasedRouting and outboundLinks loads:

https://plausible.io/js/plausible.hash.outbound-links.js

Use the Config Playground to see the exact filename and URL for any combination.

hashBasedRouting​

Tracks navigation within single-page apps that use hash-based routing (example.com/#/about). Without this, Plausible only fires on full History API navigations.

{ hashBasedRouting: true }

Automatically fires a Link: Click event whenever a visitor clicks a link to an external domain.

{ outboundLinks: true }

fileDownloads​

Fires a File Download event when a visitor clicks a link to a tracked file type.

// Use defaults (pdf, zip, docx, and ~20 more)
{ fileDownloads: true }

// Replace the default list
{ fileDownloads: { extensions: ['pdf', 'zip'] } }

// Add to the default list
{ fileDownloads: { addExtensions: ['sketch', 'fig'] } }

taggedEvents​

Fires custom events on HTML elements that have the data-analytics attribute. No JavaScript required on your part — just add the attribute.

<button data-analytics='"Signup"'>Sign up</button>
{ taggedEvents: true }

revenue​

Enables ecommerce revenue tracking. Allows passing a revenue object with currency and amount when calling window.plausible.

{ revenue: true }

captureOnLocalhost​

By default Plausible ignores localhost. Enable this to capture events during local development.

{ captureOnLocalhost: true }

manualPageviews​

Disables Plausible's built-in automatic pageview on script load. The plugin's Docusaurus client module still fires pageviews on every route change via window.plausible('pageview').

Use this when you want full control over when pageviews are sent (e.g. to exclude certain routes before the event fires).

{ manualPageviews: true }

compat​

Uses the compatibility script variant, which works in browsers that block the standard tracker (e.g. Firefox with enhanced tracking protection).

{ compat: true }

pageviewProps​

Allows attaching custom properties to every automatic pageview event. Useful for segmenting traffic by plan, locale, or any other dimension you pass via window.plausible.pageviewProps.

{ pageviewProps: true }