
Security News
Research
Destructive npm Packages Disguised as Utilities Enable Remote System Wipe
Socket uncovered two npm packages that register hidden HTTP endpoints to delete all files on command.
TypeDoc is a documentation generator for TypeScript projects. It reads your TypeScript source code and its comments and produces an HTML documentation website. It is capable of creating readable and user-friendly documentation for TypeScript projects, which can be very helpful for both maintaining internal code and for sharing code with external users.
Generating Documentation
This command generates documentation for the TypeScript source files located in the 'src' directory and outputs the result to the 'docs' directory.
typedoc --out docs src
Customizing the Theme
This command generates documentation with a minimal theme, which is one of the built-in themes provided by TypeDoc.
typedoc --out docs src --theme minimal
Excluding Private Members
This command generates documentation while excluding private members from the output, making the documentation cleaner if private members are not intended to be part of the public API.
typedoc --out docs src --excludePrivate
Including Declaration Files
This command includes type declaration files (d.ts files) in the documentation generation process, which can be useful for documenting the types that are part of the project's external API.
typedoc --out docs src --includeDeclarations
JSDoc is a popular documentation generator for JavaScript. It uses comments in the source code to generate comprehensive documentation. While similar in purpose to TypeDoc, JSDoc is tailored for JavaScript and requires additional plugins to work well with TypeScript.
ESDoc is another documentation generator for JavaScript, with support for ES6+ syntax. It provides features like coverage reporting and integrated test codes in the documentation. ESDoc is not as TypeScript-focused as TypeDoc and may require additional configuration for TypeScript projects.
Documentation generator for TypeScript projects.
For more detailed documentation, the changelog, and TypeDoc documentation rendered with TypeDoc, see https://typedoc.org.
TypeDoc runs on Node.js and is available as a NPM package.
npm install typedoc --save-dev
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:
typedoc src/index.ts
If you have multiple entry points, specify each of them.
typedoc 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.
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
For a complete list of the command line arguments run typedoc --help
or visit
our website.
--out <path/to/documentation/>
./docs
--json <path/to/output.json>
--out
is also
specified.--options
--tsconfig <path/to/tsconfig.json>
--exclude <pattern>
--theme <default|plugin defined theme>
--name <Documentation title>
--readme <path/to/readme|none>
none
to disable the index page
and start the documentation on the globals page.--version
--help
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.
v0.28.5 (2025-05-26)
ignoredHighlightLanguages
can now be used to prevent warnings for codeblocks containing languages
which are supported by Shiki but are not loaded, #2956.FAQs
Create api documentation for TypeScript projects.
The npm package typedoc receives a total of 2,087,953 weekly downloads. As such, typedoc popularity was classified as popular.
We found that typedoc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket uncovered two npm packages that register hidden HTTP endpoints to delete all files on command.
Research
Security News
Malicious Ruby gems typosquat Fastlane plugins to steal Telegram bot tokens, messages, and files, exploiting demand after Vietnam’s Telegram ban.
Research
Security News
Socket uncovered four malicious npm packages that exfiltrate up to 85% of a victim’s Ethereum or BSC wallet using obfuscated JavaScript.