cis-oss/notify
2
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects 1 Releases 1 Wiki Activity

ci(docs): Added theme to docs generator

Browse Source
This commit is contained in:
Alix von Schirp
2025-03-12 00:52:08 +01:00
parent 937358558d
commit 8f11bdc43e
3 changed files with 20 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
package.json
View File

@@ -24,11 +24,11 @@
}, },
"main": "dist/index.js", "main": "dist/index.js",
"scripts": { "scripts": {
"build": "tsc && typedoc", "build": "tsc",
"lint": "eslint --cache .", "lint": "eslint --cache .",
"typecheck": "tsc --noEmit", "typecheck": "tsc --noEmit",
"format:check": "prettier --check .", "format:check": "prettier --check .",
"check": "pnpm lint && pnpm typecheck && pnpm format:check", "check": "pnpm lint && pnpm typecheck",
"prepare": "husky", "prepare": "husky",
"docs:generate": "typedoc" "docs:generate": "typedoc"
}, },
@@ -49,6 +49,7 @@
"typedoc-plugin-inline-sources": "^1.2.1", "typedoc-plugin-inline-sources": "^1.2.1",
"typedoc-plugin-mdn-links": "^5.0.1", "typedoc-plugin-mdn-links": "^5.0.1",
"typedoc-plugin-zod": "^1.4.0", "typedoc-plugin-zod": "^1.4.0",
"typedoc-github-theme": "^0.2.1",
"typescript": "^5.5.3", "typescript": "^5.5.3",
"typescript-eslint": "^8.26.0" "typescript-eslint": "^8.26.0"
}, },

13
pnpm-lock.yaml generated
View File

@@ -8,6 +8,9 @@ importers:
.: .:
dependencies: dependencies:
typedoc-github-theme:
specifier: ^0.2.1
version: 0.2.1(typedoc@0.27.9(typescript@5.8.2))
zod: zod:
specifier: ^3.24.2 specifier: ^3.24.2
version: 3.24.2 version: 3.24.2
@@ -750,6 +753,12 @@ packages:
resolution: {integrity: sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==} resolution: {integrity: sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==}
engines: {node: '>= 0.8.0'} engines: {node: '>= 0.8.0'}
typedoc-github-theme@0.2.1:
resolution: {integrity: sha512-pOgsS9CVAOO3JxQ1V0ocDkrPCULpoWg1OzRmn/mOlyG+vEYwUAp5DAoKrGECdNIomycxcisc8ovcMX0nHDgWTA==}
engines: {node: '>=18.0.0'}
peerDependencies:
typedoc: ^0.27.6
typedoc-plugin-coverage@3.4.1: typedoc-plugin-coverage@3.4.1:
resolution: {integrity: sha512-V23DAwinAMpGMGcL1R1s8Snr26hrjfIdwGf+4jR/65ZdmeAN+yRX0onfx5JlembTQhR6AePQ/parfQNS0AZ64A==} resolution: {integrity: sha512-V23DAwinAMpGMGcL1R1s8Snr26hrjfIdwGf+4jR/65ZdmeAN+yRX0onfx5JlembTQhR6AePQ/parfQNS0AZ64A==}
engines: {node: '>= 18'} engines: {node: '>= 18'}
@@ -1525,6 +1534,10 @@ snapshots:
dependencies: dependencies:
prelude-ls: 1.2.1 prelude-ls: 1.2.1
typedoc-github-theme@0.2.1(typedoc@0.27.9(typescript@5.8.2)):
dependencies:
typedoc: 0.27.9(typescript@5.8.2)
typedoc-plugin-coverage@3.4.1(typedoc@0.27.9(typescript@5.8.2)): typedoc-plugin-coverage@3.4.1(typedoc@0.27.9(typescript@5.8.2)):
dependencies: dependencies:
typedoc: 0.27.9(typescript@5.8.2) typedoc: 0.27.9(typescript@5.8.2)

9
typedoc.config.mjs
View File

@@ -19,12 +19,11 @@ const config = {
"typedoc-plugin-zod", "typedoc-plugin-zod",
"typedoc-plugin-include-example", "typedoc-plugin-include-example",
"@shipgirl/typedoc-plugin-versions", "@shipgirl/typedoc-plugin-versions",
"typedoc-github-theme",
], ],
footerTypedocVersion: true, customFooterHtml: '<p class="tsd-generator" style="display: inline-flex; flex-direction: row; justify-content: space-around; width: 100%;"> <span> Made with ❤ by <a href="https://b00tload.space">Alix von Schirp</a> @ <a href="https://github.com/cis-oss">CISLabs OSS</a> </span> <span> <a href="https://github.com/cis-oss/pushover" target="_blank">GitHub</a> | <a href="https://github.com/cis-oss/pushover/issues" target="_blank">Issues</a> | <a href="https://github.com/cis-oss/pushover/blob/main/LICENSE" target="_blank">License</a> </span> <span>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc </a> with <a href="https://github.com/JulianWowra/typedoc-github-theme" target="_blank">typedoc-github-theme</a></span></p>',
footerLastModified: true, coverageOutputType: "json",
coverageLabel: "Docs Coverage", hideGenerator: true,
coverageOutputType: "all",
coverageSvgWidth: 130,
}; };
export default config; export default config;