Txlemetry plugin for Docusaurus

Easily track and improve your Docusaurus site with Txlemetry. See our docs on this plugin for more information.

Installing the plugin

npm install @txlemetry/docusaurus --save

or

yarn add @txlemetry/docusaurus

Configuring the plugin

// docusaurus.config.js
module.exports = {
  plugins: [
    [
      '@txlemetry/docusaurus',
      {
        apiKey: '<txlemetry_project_api_key>',
        appUrl: '<txlemetry_client_api_host>', // optional, defaults to "https://app.txlemetry.com"
        enableInDevelopment: false, // optional
      },
    ],
  ],
}

**Note:**You can pass additional Txlemetry config options to the plugin, but they are passed through JSON.stringify(), so functions (such as sanitize_properties) are not supported.

Using the plugin

Once running, this autocaptures pageviews, events, and session replay (if enabled) and enables usage of other Txlemetry features like surveys.