Socket
Socket
Sign inDemoInstall

typedoc-plugin-umami

Package Overview
Dependencies
12
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    typedoc-plugin-umami

A plugin for Typedoc that adds Umami analytics to your documentation


Version published
Weekly downloads
1
Maintainers
1
Created
Weekly downloads
 

Readme

Source

Typedoc Umami

Usage

Install:

npm install typedoc-plugin-umami

typedoc.json

{
  "plugin": ["typedoc-plugin-umami"],
  "umamiOptions": {
    "src": "https://example.com/script.js", // Required, Umami script src
    "websiteId": "00000000-0000-0000-0000-000000000000" // Required, Umami website id
    // Optional options, see https://umami.is/docs/tracker-configuration for details
    "hostUrl": "",
    "autoTrack": true,
    "doNotTrack": false,
    "dataCache": true,
    "domains": []
  }
}

typedoc.config.cjs

/** @type {import('typedoc-plugin-umami').TypeDocOptions} */
module.exports = {
  plugin: ["typedoc-plugin-umami"],
  umamiOptions: {
    src: "https://example.com/script.js", // Required, Umami script src
    websiteId: "00000000-0000-0000-0000-000000000000", // Required, Umami website id
    // Optional options, see https://umami.is/docs/tracker-configuration for details
    hostUrl: "",
    autoTrack: true,
    doNotTrack: false,
    dataCache: true,
    domains: [],
  },
};

Keywords

FAQs

Last updated on 16 May 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc