Skip to content

Plugin for TypeDoc that adds Umami analytics support

License

Notifications You must be signed in to change notification settings

jamesatjaminit/typedoc-plugin-umami

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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: [],
  },
};