All integrations

Docusaurus

Docusaurus loads anything in the scripts option on every page.

Steps

  1. Open docusaurus.config.js (or docusaurus.config.ts).
  2. Add the entry below to the top-level scripts array. Replace SITE_ID with your Site ID.
  3. Rebuild and deploy.

The snippet

Replace SITE_ID with the ID from your Glyphex site settings.

// docusaurus.config.js
export default {
  // ...
  scripts: [
    { src: "https://glyphex.io/t/SITE_ID.js", defer: true },
  ],
};

Docusaurus is a single-page app after the first load. Navigation between docs pages is tracked automatically.

Verify it works

Open your live site in a new tab, then open Realtime in your Glyphex dashboard. Your visit should show up within a few seconds. You can also open your site's Getting started page and click Check installation, which fetches your URL and looks for the tag.

Cookies and consent

Glyphex sets no cookies and stores nothing on the visitor's device, so it needs no cookie banner.

Track custom events

Use the data attributes in MDX or custom components:

<button
  data-glyphex-event="download_click"
  data-glyphex-event-file="guide"
>
  Download
</button>

Events can also be sent with window.analytics.track(name, props) or the declarative data-glyphex-event and data-glyphex-event-<prop> attributes.

Troubleshooting

  • No data? Check that the Site ID matches exactly and the page was republished or the cache cleared.
  • Ad blockers can block analytics scripts. Disable yours to test.
  • Content Security Policy: allow https://glyphex.io in both script-src and connect-src.
  • Check DevTools > Network for a request to glyphex.io/t/. A 404 means the Site ID is wrong.

Custom events

Installation