{"id":45808529,"url":"https://github.com/TypeStrong/TypeDoc","last_synced_at":"2026-03-11T23:01:01.092Z","repository":{"id":17359935,"uuid":"20131603","full_name":"TypeStrong/typedoc","owner":"TypeStrong","description":"Documentation generator for TypeScript projects.","archived":false,"fork":false,"pushed_at":"2026-02-28T04:42:03.000Z","size":17985,"stargazers_count":8375,"open_issues_count":11,"forks_count":760,"subscribers_count":70,"default_branch":"master","last_synced_at":"2026-03-08T17:19:18.847Z","etag":null,"topics":["documentation","generator","typescript"],"latest_commit_sha":null,"homepage":"https://typedoc.org","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TypeStrong.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"gerrit0"}},"created_at":"2014-05-24T14:40:16.000Z","updated_at":"2026-03-07T00:13:41.000Z","dependencies_parsed_at":"2023-09-25T01:36:12.796Z","dependency_job_id":"77f14370-5c03-4db5-b197-e51c2680807b","html_url":"https://github.com/TypeStrong/typedoc","commit_stats":{"total_commits":2902,"total_committers":233,"mean_commits":"12.454935622317597","dds":0.4086836664369401,"last_synced_commit":"0e52193eec161826c3e0349d69f97f202bfb1eb0"},"previous_names":["sebastian-lenz/typedoc"],"tags_count":251,"template":false,"template_full_name":null,"purl":"pkg:github/TypeStrong/typedoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeStrong%2Ftypedoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeStrong%2Ftypedoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeStrong%2Ftypedoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeStrong%2Ftypedoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TypeStrong","download_url":"https://codeload.github.com/TypeStrong/typedoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypeStrong%2Ftypedoc/sbom","scorecard":{"id":144886,"data":{"date":"2022-08-15","repo":{"name":"github.com/TypeStrong/typedoc","commit":"ae459f88de812baa6cba8c62f73f73d317c99131"},"scorecard":{"version":"v4.5.0-17-g7772984","commit":"777298477c07c262a4ec7e95ceee839b7b3b75ae"},"score":6.3,"checks":[{"name":"Code-Review","score":1,"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"],"documentation":{"short":"Determines if the project requires code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/777298477c07c262a4ec7e95ceee839b7b3b75ae/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"30 commit(s) out of 30 and 25 issue activity out of 30 found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/777298477c07c262a4ec7e95ceee839b7b3b75ae/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no badge detected","details":null,"documentation":{"short":"Determines if the project has a CII Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/777298477c07c262a4ec7e95ceee839b7b3b75ae/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"no vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/777298477c07c262a4ec7e95ceee839b7b3b75ae/docs/checks.md#vulnerabilities"}},{"name":"Token-Permissions","score":0,"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"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/777298477c07c262a4ec7e95ceee839b7b3b75ae/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/777298477c07c262a4ec7e95ceee839b7b3b75ae/docs/checks.md#dangerous-workflow"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy detected in current repo: .github/SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/777298477c07c262a4ec7e95ceee839b7b3b75ae/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: : LICENSE:1"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/777298477c07c262a4ec7e95ceee839b7b3b75ae/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":["Warn: no GitHub releases found"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/777298477c07c262a4ec7e95ceee839b7b3b75ae/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/777298477c07c262a4ec7e95ceee839b7b3b75ae/docs/checks.md#branch-protection"}},{"name":"Packaging","score":-1,"reason":"no published package detected","details":["Warn: no GitHub publishing workflow detected"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/777298477c07c262a4ec7e95ceee839b7b3b75ae/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/777298477c07c262a4ec7e95ceee839b7b3b75ae/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":7,"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"],"documentation":{"short":"Determines if the project has declared and pinned its dependencies.","url":"https://github.com/ossf/scorecard/blob/777298477c07c262a4ec7e95ceee839b7b3b75ae/docs/checks.md#pinned-dependencies"}},{"name":"Dependency-Update-Tool","score":10,"reason":"update tool detected","details":["Info: Dependabot detected"],"documentation":{"short":"Determines if the project uses a dependency update tool.","url":"https://github.com/ossf/scorecard/blob/777298477c07c262a4ec7e95ceee839b7b3b75ae/docs/checks.md#dependency-update-tool"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":null,"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/777298477c07c262a4ec7e95ceee839b7b3b75ae/docs/checks.md#fuzzing"}}]},"last_synced_at":"2025-08-16T09:11:38.984Z","repository_id":17359935,"created_at":"2025-08-16T09:11:38.984Z","updated_at":"2025-08-16T09:11:38.984Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30406400,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-11T22:36:59.286Z","status":"ssl_error","status_checked_at":"2026-03-11T22:36:57.544Z","response_time":84,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","generator","typescript"],"created_at":"2026-02-26T15:00:31.398Z","updated_at":"2026-03-11T23:01:01.087Z","avatar_url":"https://github.com/TypeStrong.png","language":"TypeScript","funding_links":["https://github.com/sponsors/gerrit0"],"categories":["Uncategorized"],"sub_categories":["Uncategorized"],"readme":"# TypeDoc\n\nDocumentation generator for TypeScript projects.\n\n## Documentation\n\nFor more detailed documentation, the changelog, and TypeDoc documentation rendered with TypeDoc, see https://typedoc.org.\n\n## Installation\n\nTypeDoc runs on Node.js and is available as a NPM package.\n\n```text\nnpm install typedoc --save-dev\n```\n\n## Usage\n\nTo generate documentation TypeDoc needs to know your project entry point and TypeScript\ncompiler options. It will automatically try to find your `tsconfig.json` file, so you can\njust specify the entry point of your library:\n\n```text\ntypedoc src/index.ts\n```\n\nIf you have multiple entry points, specify each of them.\n\n```text\ntypedoc package1/index.ts package2/index.ts\n```\n\nIf you specify a directory, TypeDoc will use the `entryPointStrategy` option to determine how to resolve it.\nBy default, TypeDoc will search for a file called `index` under the directory.\n\n### Monorepos / Workspaces\n\nIf your codebase is comprised of one or more npm packages, you can build documentation for each of them individually\nand merge the results together into a single site by setting `entryPointStrategy` to `packages`. In this mode TypeDoc\nrequires configuration to be present in each directory to specify the entry points. For an example setup, see\nhttps://github.com/Gerrit0/typedoc-packages-example\n\n### Arguments\n\nFor a complete list of the command line arguments run `typedoc --help` or visit\n[our website](https://typedoc.org/options/).\n\n- `--out \u003cpath/to/documentation/\u003e`\u003cbr\u003e\n  Specifies the location the documentation should be written to. Defaults to `./docs`\n- `--json \u003cpath/to/output.json\u003e`\u003cbr\u003e\n  Specifies the location and file name a json file describing the project is\n  written to. When specified no documentation will be generated unless `--out` is also\n  specified.\n- `--options`\u003cbr\u003e\n  Specify a json option file that should be loaded. If not specified TypeDoc\n  will look for 'typedoc.json' in the current directory.\n- `--tsconfig \u003cpath/to/tsconfig.json\u003e`\u003cbr\u003e\n  Specify a typescript config file that should be loaded. If not\n  specified TypeDoc will look for 'tsconfig.json' in the current directory.\n- `--exclude \u003cpattern\u003e`\u003cbr\u003e\n  Exclude files by the given pattern when a path is provided as source.\n  Supports standard minimatch patterns.\n\n#### Theming\n\n- `--theme \u003cdefault|plugin defined theme\u003e`\u003cbr\u003e\n  Specify the theme that should be used.\n- `--name \u003cDocumentation title\u003e`\u003cbr\u003e\n  Set the name of the project that will be used in the header of the template.\n- `--readme \u003cpath/to/readme|none\u003e`\u003cbr\u003e\n  Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page\n  and start the documentation on the globals page.\n\n#### Miscellaneous\n\n- `--version`\u003cbr\u003e\n  Display the version number of TypeDoc.\n- `--help`\u003cbr\u003e\n  Display all TypeDoc options.\n\n## Contributing\n\nThis project is maintained by a community of developers. Contributions are welcome and appreciated.\nYou can find TypeDoc on GitHub; feel free to open an issue or create a pull request:\nhttps://github.com/TypeStrong/typedoc\n\nFor more information, read the [contribution guide](https://github.com/TypeStrong/typedoc/blob/master/.github/CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTypeStrong%2FTypeDoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTypeStrong%2FTypeDoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTypeStrong%2FTypeDoc/lists"}