Gathering detailed insights and metrics for typedoc
Gathering detailed insights and metrics for typedoc
Documentation generator for TypeScript projects.
Installations
npm install typedocReleases
222
Developer
Developer Guide
BETA
Module System
ESM
Min. Node Version
>= 18
Typescript Support
Yes
Node Version
18.20.5
NPM Version
10.8.2
Statistics
7,787 Stars
3,028 Commits
704 Forks
73 Watching
6 Branches
241 Contributors
Updated on 29 Nov 2024
Languages
TypeScript (94.91%)
JavaScript (2.72%)
CSS (2.31%)
Shell (0.05%)
Batchfile (0.01%)
Total Downloads
Cumulative downloads
Total Downloads
177,177,726
Last day
-14.6%
357,384
Compared to previous day
Last week
2.5%
2,359,670
Compared to previous week
Last month
53%
8,499,558
Compared to previous month
Last year
44.7%
61,769,092
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
TypeDoc
Documentation generator for TypeScript projects.
Documentation
For more detailed documentation, the changelog, and TypeDoc documentation rendered with TypeDoc, see https://typedoc.org.
Installation
TypeDoc runs on Node.js and is available as a NPM package.
1npm install typedoc --save-dev
Usage
To generate documentation TypeDoc needs to know your project entry point and TypeScript
compiler options. It will automatically try to find your tsconfig.json file, so you can
just specify the entry point of your library:
1typedoc src/index.ts
If you have multiple entry points, specify each of them.
1typedoc package1/index.ts package2/index.ts
If you specify a directory, TypeDoc will use the entryPointStrategy option to determine how to resolve it.
By default, TypeDoc will search for a file called index under the directory.
Monorepos / Workspaces
If your codebase is comprised of one or more npm packages, you can build documentation for each of them individually
and merge the results together into a single site by setting entryPointStrategy to packages. In this mode TypeDoc
requires configuration to be present in each directory to specify the entry points. For an example setup, see
https://github.com/Gerrit0/typedoc-packages-example
Arguments
For a complete list of the command line arguments run typedoc --help or visit
our website.
--out <path/to/documentation/>
Specifies the location the documentation should be written to. Defaults to./docs--json <path/to/output.json>
Specifies the location and file name a json file describing the project is written to. When specified no documentation will be generated unless--outis also specified.--options
Specify a json option file that should be loaded. If not specified TypeDoc will look for 'typedoc.json' in the current directory.--tsconfig <path/to/tsconfig.json>
Specify a typescript config file that should be loaded. If not specified TypeDoc will look for 'tsconfig.json' in the current directory.--exclude <pattern>
Exclude files by the given pattern when a path is provided as source. Supports standard minimatch patterns.
Theming
--theme <default|plugin defined theme>
Specify the theme that should be used.--name <Documentation title>
Set the name of the project that will be used in the header of the template.--readme <path/to/readme|none>
Path to the readme file that should be displayed on the index page. Passnoneto disable the index page and start the documentation on the globals page.
Miscellaneous
--version
Display the version number of TypeDoc.--help
Display all TypeDoc options.
Contributing
This project is maintained by a community of developers. Contributions are welcome and appreciated. You can find TypeDoc on GitHub; feel free to open an issue or create a pull request: https://github.com/TypeStrong/typedoc
For more information, read the contribution guide.
No vulnerabilities found.
Reason
30 commit(s) out of 30 and 25 issue activity out of 30 found in the last 90 days -- score normalized to 10
Reason
no vulnerabilities detected
Reason
no dangerous workflow patterns detected
Reason
security policy file detected
Details
- Info: security policy detected in current repo: .github/SECURITY.md:1
Reason
license file detected
Details
- Info: : LICENSE:1
Reason
no binaries found in the repo
Reason
update tool detected
Details
- Info: Dependabot detected
Reason
dependency not pinned by hash detected -- score normalized to 7
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/ci.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-beta.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/publish-beta.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish-beta.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/publish-beta.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-beta.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/publish-beta.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-lts.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/publish-lts.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish-lts.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/publish-lts.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-lts.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/publish-lts.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/publish.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/visual-regression.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/visual-regression.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/visual-regression.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/visual-regression.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/visual-regression.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/visual-regression.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:19
- Warn: npmCommand not pinned by hash: .github/workflows/publish-beta.yml:25
- Warn: npmCommand not pinned by hash: .github/workflows/publish-lts.yml:25
- Warn: npmCommand not pinned by hash: .github/workflows/visual-regression.yml:15
- Info: Dockerfile dependencies are pinned
- Info: no insecure (not pinned by hash) dependency downloads found in Dockerfiles
- Info: no insecure (not pinned by hash) dependency downloads found in shell scripts
Reason
Prow code reviews found for 3 commits out of the last 30 -- score normalized to 1
Details
- Warn: no reviews found for commit: ae459f88de812baa6cba8c62f73f73d317c99131
- Warn: no reviews found for commit: a12573d556d889981e6f5af102bc66c975f7fa66
- Warn: no reviews found for commit: 295c97f2bc80ab31dde940d6c4c2470ff38a8544
- Warn: no reviews found for commit: 8a0973f163fb0ddd2902ee92c9e32218d7a0c040
- Warn: no reviews found for commit: a24381740bfed0822343e69f50e493b5db4d0eb1
- Warn: no reviews found for commit: e36ea1c8516691edfed9b43d3017fbda4cbe0c26
- Warn: no reviews found for commit: 3830f9650ec7d2bc5e7b53bd28898f23fc6c5590
- Warn: no reviews found for commit: 5d9a51d882a153012fed36dea0379a505143530d
- Warn: no reviews found for commit: 6de1e38ce094b2e136c8179646a7d07f86f9718b
- Warn: no reviews found for commit: 23bde9a2687686a8e49cd7d9579444c04a51c60f
- Warn: no reviews found for commit: 95f9bc131705097da53960d1c27c48c70d7da123
- Warn: no reviews found for commit: 3d78ebc4f165fe381ffe4e6225ff7bc4d4019547
- Warn: no reviews found for commit: 5f1a7d8ad8c70905ba22b0351a73d1432e1dfce3
- Warn: no reviews found for commit: 20ea81a35edd65a12c902482737220dde3feba58
- Warn: no reviews found for commit: ba9c5befb095879597aee54c9e77a9a939599249
- Warn: no reviews found for commit: d4d3b8f5de744b03720efe67260f0b9d1a6270af
- Warn: no reviews found for commit: 4f2a12f330aec495641d21347de60c67ad2b5a88
- Warn: no reviews found for commit: 3e5a1a247cc2d006bd04ffa6e09aaac2303e4fb6
- Warn: no reviews found for commit: 55b72aaef9538ba8e286b5e8e4235e1f5f612cca
- Warn: no reviews found for commit: 5611232cc715c7c88714682b6819e2c564e1a8fb
- Warn: no reviews found for commit: f41f6c8f578c8c60a02a0678fd37182322ad9ca8
- Warn: no reviews found for commit: 9ed9f01a6ca60b97b5209c6980d5b2db64cab01d
- Warn: no reviews found for commit: c14857ea567fb3b167cb5707481650fa967e7633
- Warn: no reviews found for commit: 366346963f5345d07cad6fc77429643acd2edbfe
- Warn: no reviews found for commit: ec9efa0628005909cf49d4b0e649e7b51c0bbb05
Reason
no badge detected
Reason
non read-only tokens detected in GitHub workflows
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/ci.yml/master?enable=permissions
- Warn: no topLevel permission defined: .github/workflows/publish-beta.yml:1: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/publish-beta.yml/master?enable=permissions
- Warn: no topLevel permission defined: .github/workflows/publish-lts.yml:1: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/publish-lts.yml/master?enable=permissions
- Warn: no topLevel permission defined: .github/workflows/publish.yml:1: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/publish.yml/master?enable=permissions
- Warn: no topLevel permission defined: .github/workflows/visual-regression.yml:1: update your workflow using https://app.stepsecurity.io/secureworkflow/Enigmatis/polaris-nest-logger/visual-regression.yml/master?enable=permissions
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
project is not fuzzed
Score
6.3
/10
Last Scanned on 2022-08-15
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More