1
0
Fork 0
mirror of https://github.com/classchartsapi/classcharts-api-js.git synced 2026-05-14 11:58:13 +00:00

chore(docs): umami

This commit is contained in:
James Cook 2023-04-29 20:43:58 +01:00
parent f808c3f32e
commit 00a22a97e4
3 changed files with 16 additions and 1 deletions

View file

@ -44,6 +44,7 @@
"prettier": "^2.8.7", "prettier": "^2.8.7",
"ts-jest": "^29.1.0", "ts-jest": "^29.1.0",
"typedoc": "^0.24.2", "typedoc": "^0.24.2",
"typedoc-plugin-umami": "^1.0.1",
"typescript": "^5.0.4" "typescript": "^5.0.4"
}, },
"types": "./dist/index.d.ts", "types": "./dist/index.d.ts",

11
pnpm-lock.yaml generated
View file

@ -42,6 +42,9 @@ devDependencies:
typedoc: typedoc:
specifier: ^0.24.2 specifier: ^0.24.2
version: 0.24.2(typescript@5.0.4) version: 0.24.2(typescript@5.0.4)
typedoc-plugin-umami:
specifier: ^1.0.1
version: 1.0.1(typedoc@0.24.2)
typescript: typescript:
specifier: ^5.0.4 specifier: ^5.0.4
version: 5.0.4 version: 5.0.4
@ -4093,6 +4096,14 @@ packages:
is-typed-array: 1.1.10 is-typed-array: 1.1.10
dev: true 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): /typedoc@0.24.2(typescript@5.0.4):
resolution: {integrity: sha512-Ln1EItgcdKfRzaFSfs9uEc4amz9ZeUZoaTbFdH0ZC8ScA2OjvNMdW7vrjTtZwKE0iF38njUmuFFgQMP4tDl7ag==} resolution: {integrity: sha512-Ln1EItgcdKfRzaFSfs9uEc4amz9ZeUZoaTbFdH0ZC8ScA2OjvNMdW7vrjTtZwKE0iF38njUmuFFgQMP4tDl7ag==}
engines: {node: '>= 14.14'} engines: {node: '>= 14.14'}

View file

@ -1,6 +1,7 @@
/** @type {import('typedoc').TypeDocOptions} */ /** @type {import('typedoc-plugin-umami').TypeDocOptions} */
module.exports = { module.exports = {
entryPointStrategy: "resolve", entryPointStrategy: "resolve",
plugin: ["typedoc-plugin-umami"],
entryPoints: [ entryPoints: [
"src/studentClient.ts", "src/studentClient.ts",
"src/parentClient.ts", "src/parentClient.ts",
@ -14,4 +15,6 @@ module.exports = {
includeVersion: true, includeVersion: true,
out: "docs", out: "docs",
sort: "required-first", sort: "required-first",
umamiScriptSrc: "https://umami.jaminit.co.uk/script.js",
umamiWebsiteId: "dd8c53b8-dc99-484c-911d-b08c898498a8",
}; };