MyST Markdown

Analytics

There are no tracking cookies or analytics added to a mystjs site by default, however, you may want to know more about basic analytics for your domain when you deploy it. There are two analytics tracking codes that mystjs currently supports:

Google Analytics; and
Plausible, which is privacy-friendly alternative to Google.

These are set using the analytics: part of your site configuration using either a google: or a plausible: key.

Google Analytics¶

Use the site.analytics.google configuration, with the contents being your Measurement ID (G-XXXXXX) or Tracking ID (UA-XXXXXX).

version: 1
site:
  analytics:
    google: UA-XXXXX # Measurement ID or Tracking ID

See Google Analytics docs for more information on how to find this Measurement ID.

Plausible¶

Use the site.analytics.plausible configuration, with the contents being the domain you are tracking.

version: 1
site:
  analytics:
    plausible: myst-tools.org # Domain(s) to track

See Plausible docs for more information on how to find the domain. Note, you only copy in the contents of: data-domain="COPY_THIS", which can be a comma-separated list for multiple domains.

Testing your integration¶

Run myst start and view the page source. The analytics section should be in the <head> section of the HTML, you should also start to see real-time tracking in your dashboard.

Websites

Accessibility & performance

Documents

Scientific PDFs