From 00a22a97e40b0f4ba3504a732a2e9a7d734edbb1 Mon Sep 17 00:00:00 2001 From: James Cook Date: Sat, 29 Apr 2023 20:43:58 +0100 Subject: [PATCH] chore(docs): umami --- package.json | 1 + pnpm-lock.yaml | 11 +++++++++++ typedoc.config.cjs | 5 ++++- 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 24d8e57..3581369 100644 --- a/package.json +++ b/package.json @@ -44,6 +44,7 @@ "prettier": "^2.8.7", "ts-jest": "^29.1.0", "typedoc": "^0.24.2", + "typedoc-plugin-umami": "^1.0.1", "typescript": "^5.0.4" }, "types": "./dist/index.d.ts", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 5b317d0..333a7c4 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -42,6 +42,9 @@ devDependencies: typedoc: specifier: ^0.24.2 version: 0.24.2(typescript@5.0.4) + typedoc-plugin-umami: + specifier: ^1.0.1 + version: 1.0.1(typedoc@0.24.2) typescript: specifier: ^5.0.4 version: 5.0.4 @@ -4093,6 +4096,14 @@ packages: is-typed-array: 1.1.10 dev: true + /typedoc-plugin-umami@1.0.1(typedoc@0.24.2): + resolution: {integrity: sha512-alBDvMWJKvtzzrPJZ9cdoe9JJB0YfuUbV2rDm/Onxiopa4vwwqiTywPwLBChhFG0XHM7DpRytvi3VPr57bfmMQ==} + peerDependencies: + typedoc: ^0.23.0 + dependencies: + typedoc: 0.24.2(typescript@5.0.4) + dev: true + /typedoc@0.24.2(typescript@5.0.4): resolution: {integrity: sha512-Ln1EItgcdKfRzaFSfs9uEc4amz9ZeUZoaTbFdH0ZC8ScA2OjvNMdW7vrjTtZwKE0iF38njUmuFFgQMP4tDl7ag==} engines: {node: '>= 14.14'} diff --git a/typedoc.config.cjs b/typedoc.config.cjs index fd57425..431b9ef 100644 --- a/typedoc.config.cjs +++ b/typedoc.config.cjs @@ -1,6 +1,7 @@ -/** @type {import('typedoc').TypeDocOptions} */ +/** @type {import('typedoc-plugin-umami').TypeDocOptions} */ module.exports = { entryPointStrategy: "resolve", + plugin: ["typedoc-plugin-umami"], entryPoints: [ "src/studentClient.ts", "src/parentClient.ts", @@ -14,4 +15,6 @@ module.exports = { includeVersion: true, out: "docs", sort: "required-first", + umamiScriptSrc: "https://umami.jaminit.co.uk/script.js", + umamiWebsiteId: "dd8c53b8-dc99-484c-911d-b08c898498a8", };