typedoc-plugin-umami
v1.3.0
Published
A plugin for Typedoc that adds Umami analytics to your documentation
Downloads
5
Readme
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: [],
},
};